---
title: "POST /v1/{+parent}/entities"
method: POST
path: "/v1/{+parent}/entities"
tags: ["projects"]
---

# POST /v1/{+parent}/entities

`POST /v1/{+parent}/entities`

Create a metadata entity.

## Path parameters

- `parent` string, required

## Query parameters

- `validateOnly` boolean

## Request body

- GoogleCloudDataplexV1Entity — Represents tables and fileset metadata contained within a zone.
  - `type` 'TYPE_UNSPECIFIED' | 'TABLE' | 'FILESET' — Required. Immutable. The type of entity.
  - `createTime` string, google-datetime — Output only. The time when the entity was created.
  - `updateTime` string, google-datetime — Output only. The time when the entity was last updated.
  - `schema` GoogleCloudDataplexV1Schema — Schema information describing the structure and layout of the data.
    - `userManaged` boolean — Required. Set to true if user-managed or false if managed by Dataplex Universal Catalog. The default is false (managed by Dataplex Universal Catalog). Set to falseto enable Dataplex Universal Catalog discovery to update the schema. including new data discovery, schema inference, and schema evolution. Users retain the ability to input and edit the schema. Dataplex Universal Catalog treats schema input by the user as though produced by a previous Dataplex Universal Catalog discovery operation, and it will evolve the schema and take action based on that treatment. Set to true to fully manage the entity schema. This setting guarantees that Dataplex Universal Catalog will not change schema fields.
    - `partitionFields` GoogleCloudDataplexV1SchemaPartitionField[] — Optional. The sequence of fields describing the partition structure in entities. If this field is empty, there are no partitions within the data.
      - `name` string — Required. Partition field name must consist of letters, numbers, and underscores only, with a maximum of length of 256 characters, and must begin with a letter or underscore..
      - `type` 'TYPE_UNSPECIFIED' | 'BOOLEAN' | 'BYTE' | 'INT16' | 'INT32' | 'INT64' | 'FLOAT' | 'DOUBLE' | 'DECIMAL' | 'STRING' | 'BINARY' | 'TIMESTAMP' | 'DATE' | 'TIME' | 'RECORD' | 'NULL' — Required. Immutable. The type of field.
    - `fields` GoogleCloudDataplexV1SchemaSchemaField[] — Optional. The sequence of fields describing data in table entities. Note: BigQuery SchemaFields are immutable.
      - `type` 'TYPE_UNSPECIFIED' | 'BOOLEAN' | 'BYTE' | 'INT16' | 'INT32' | 'INT64' | 'FLOAT' | 'DOUBLE' | 'DECIMAL' | 'STRING' | 'BINARY' | 'TIMESTAMP' | 'DATE' | 'TIME' | 'RECORD' | 'NULL' — Required. The type of field.
      - `fields` GoogleCloudDataplexV1SchemaSchemaField[] — Optional. Any nested field for complex types.
      - `name` string — Required. The name of the field. Must contain only letters, numbers and underscores, with a maximum length of 767 characters, and must begin with a letter or underscore.
      - `mode` 'MODE_UNSPECIFIED' | 'REQUIRED' | 'NULLABLE' | 'REPEATED' — Required. Additional field semantics.
      - `description` string — Optional. User friendly field description. Must be less than or equal to 1024 characters.
    - `partitionStyle` 'PARTITION_STYLE_UNSPECIFIED' | 'HIVE_COMPATIBLE' — Optional. The structure of paths containing partition data within the entity.
  - `asset` string — Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.
  - `system` 'STORAGE_SYSTEM_UNSPECIFIED' | 'CLOUD_STORAGE' | 'BIGQUERY' — Required. Immutable. Identifies the storage system of the entity data.
  - `dataPath` string — Required. Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id.
  - `access` GoogleCloudDataplexV1StorageAccess — Describes the access mechanism of the data within its storage location.
    - `read` 'ACCESS_MODE_UNSPECIFIED' | 'DIRECT' | 'MANAGED' — Output only. Describes the read access mechanism of the data. Not user settable.
  - `description` string — Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.
  - `name` string — Output only. The resource name of the entity, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}.
  - `etag` string — Optional. The etag associated with the entity, which can be retrieved with a GetEntity request. Required for update and delete requests.
  - `uid` string — Output only. System generated unique ID for the Entity. This ID will be different if the Entity is deleted and re-created with the same name.
  - `id` string — Required. A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores, and consist of 256 or fewer characters.
  - `compatibility` GoogleCloudDataplexV1EntityCompatibilityStatus — Provides compatibility information for various metadata stores.
    - `hiveMetastore` GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility — Provides compatibility information for a specific metadata store.
      - `compatible` boolean — Output only. Whether the entity is compatible and can be represented in the metadata store.
      - `reason` string — Output only. Provides additional detail if the entity is incompatible with the metadata store.
    - `bigquery` GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility — Provides compatibility information for a specific metadata store.
      - `compatible` boolean — Output only. Whether the entity is compatible and can be represented in the metadata store.
      - `reason` string — Output only. Provides additional detail if the entity is incompatible with the metadata store.
  - `format` GoogleCloudDataplexV1StorageFormat — Describes the format of the data within its storage location.
    - `csv` GoogleCloudDataplexV1StorageFormatCsvOptions — Describes CSV and similar semi-structured data formats.
      - `headerRows` integer — Optional. The number of rows to interpret as header rows that should be skipped when reading data rows. Defaults to 0.
      - `quote` string — Optional. The character used to quote column values. Accepts '"' (double quotation mark) or ''' (single quotation mark). Defaults to '"' (double quotation mark) if unspecified.
      - `encoding` string — Optional. The character encoding of the data. Accepts "US-ASCII", "UTF-8", and "ISO-8859-1". Defaults to UTF-8 if unspecified.
      - `delimiter` string — Optional. The delimiter used to separate values. Defaults to ','.
    - `format` 'FORMAT_UNSPECIFIED' | 'PARQUET' | 'AVRO' | 'ORC' | 'CSV' | 'JSON' | 'IMAGE' | 'AUDIO' | 'VIDEO' | 'TEXT' | 'TFRECORD' | 'OTHER' | 'UNKNOWN' — Output only. The data format associated with the stored data, which represents content type values. The value is inferred from mime type.
    - `compressionFormat` 'COMPRESSION_FORMAT_UNSPECIFIED' | 'GZIP' | 'BZIP2' — Optional. The compression type associated with the stored data. If unspecified, the data is uncompressed.
    - `json` GoogleCloudDataplexV1StorageFormatJsonOptions — Describes JSON data format.
      - `encoding` string — Optional. The character encoding of the data. Accepts "US-ASCII", "UTF-8" and "ISO-8859-1". Defaults to UTF-8 if not specified.
    - `mimeType` string — Required. The mime type descriptor for the data. Must match the pattern {type}/{subtype}. Supported values: application/x-parquet application/x-avro application/x-orc application/x-tfrecord application/x-parquet+iceberg application/x-avro+iceberg application/x-orc+iceberg application/json application/{subtypes} text/csv text/ image/{image subtype} video/{video subtype} audio/{audio subtype}
    - `iceberg` GoogleCloudDataplexV1StorageFormatIcebergOptions — Describes Iceberg data format.
      - `metadataLocation` string — Optional. The location of where the iceberg metadata is present, must be within the table path
  - `displayName` string — Optional. Display name must be shorter than or equal to 256 characters.
  - `dataPathPattern` string — Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/**/*.csv.
  - `catalogEntry` string — Output only. The name of the associated Data Catalog entry.

## Response `200`

Successful response

---

[API](https://skmtc.net/google/apis/dataplex.md) · [All operations](https://skmtc.net/google/apis/dataplex/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/dataplex/versions/43a3b60ca93b/schema)