Sign in

v1

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

Update a metadata entity. Only supports full resource update.

put/v1/{+name}

Path parameters

namestring required

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

Query parameters

validateOnlyboolean

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

Request body

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

Required. Immutable. The type of entity.

createTimestring google-datetime

Output only. The time when the entity was created.

updateTimestring google-datetime

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

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.

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

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

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.

descriptionstring

Optional. User friendly longer description text. Must be shorter than or equal to 1024 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}.

etagstring

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

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.

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.

displayNamestring

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

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.

catalogEntrystring

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

Response

Successful response