projects

Changed on

Create a metadata entity.

post/v1/{+parent}/entities

Request

  • Base URL: https://dataplex.googleapis.com
  • URL: https://dataplex.googleapis.com/v1/{+parent}/entities
  • Auth: one of:
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/cloud-platform) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/cloud-platform)
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/dataplex.read-write) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/dataplex.read-write)

Path parameters

parentstring required

Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.

Query parameters

validateOnlyboolean

Optional. Only validate the request, but do not perform mutations. The default is false.

Request body

assetstring

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.

catalogEntrystring

Output only. The name of the associated Data Catalog entry.

createTimestring google-datetime

Output only. The time when the entity was created.

dataPathstring

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.

dataPathPatternstring

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.

descriptionstring

Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.

displayNamestring

Optional. Display name must be shorter than or equal to 256 characters.

etagstring

Optional. The etag associated with the entity, which can be retrieved with a GetEntity request. Required for update and delete requests.

idstring

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.

namestring

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}.

system'STORAGE_SYSTEM_UNSPECIFIED' | 'CLOUD_STORAGE' | 'BIGQUERY'

Required. Immutable. Identifies the storage system of the entity data.

type'TYPE_UNSPECIFIED' | 'TABLE' | 'FILESET'

Required. Immutable. The type of entity.

uidstring

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.

updateTimestring google-datetime

Output only. The time when the entity was last updated.

Response

Successful response

Changes

  • 6c7e9028cba8Revision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/dataplex.read-write was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/dataplex.read-write was removed from the endpoint's security scheme Oauth2c

  • 395bfc8abfeeRevision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/dataplex.read-write was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/dataplex.read-write was removed from the endpoint's security scheme Oauth2c