2026-11-07
▼ ▲ datacatalog.projects.locations.entryGroups.testIamPermissions
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Description : Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (We don't return a `NOT_FOUND` error). Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog. A caller is not required to have Google IAM permission to make this request.
Deprecated : Yes
Path : v1beta1/{+resource}:testIamPermissions
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:testIamPermissions
Parameters :
resource
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$
Required : Yes
Type : string
▼ ▲ datacatalog.projects.locations.entryGroups.create
Parameters :
parent
Description : Required. The name of the project this entry group is in. Example: * projects/{project_id}/locations/{location} Note that this EntryGroup and its child resources may not actually be stored in the location in this name.
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
entryGroupId
Description : Required. The id of the entry group to create. The id must begin with a letter or underscore, contain only English letters, numbers and underscores, and be at most 64 characters.
Type : string
Location : query
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups
Deprecated : Yes
Parameter Order : parent
Path : v1beta1/{+parent}/entryGroups
Description : A maximum of 10,000 entry groups may be created per organization across all locations. Users should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
HTTP Method : POST
▼ ▲ datacatalog.projects.locations.entryGroups.delete
Deprecated : Yes
Parameters :
force
Location : query
Description : Optional. If true, deletes all entries in the entry group.
Type : boolean
name
Required : Yes
Type : string
Location : path
Description : Required. The name of the entry group. For example, `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+name}
Parameter Order : name
HTTP Method : DELETE
Description : Deletes an EntryGroup. Only entry groups that do not contain entries can be deleted. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}
▼ ▲ datacatalog.projects.locations.entryGroups.patch
Scopes : https://www.googleapis.com/auth/cloud-platform
Deprecated : Yes
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}
Parameters :
updateMask
Description : Names of fields whose values to overwrite on an entry group. If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.
Format : google-fieldmask
Type : string
Location : query
name
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$
Type : string
Description : Identifier. The resource name of the entry group in URL format. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} Note that this EntryGroup and its child resources may not actually be stored in the location in this name.
Location : path
Required : Yes
Path : v1beta1/{+name}
Description : Updates an EntryGroup. The user should enable the Data Catalog API in the project identified by the `entry_group.name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
Parameter Order : name
HTTP Method : PATCH
▼ ▲ datacatalog.projects.locations.entryGroups.getIamPolicy
Deprecated : Yes
Path : v1beta1/{+resource}:getIamPolicy
Parameters :
resource
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$
Location : path
Required : Yes
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Type : string
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:getIamPolicy
Description : Gets the access control policy for a resource. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it. Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog. Callers must have following Google IAM permission - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entries.getIamPolicy` to get policies on entries. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
Parameter Order : resource
HTTP Method : POST
▼ ▲ datacatalog.projects.locations.entryGroups.list
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Path : v1beta1/{+parent}/entryGroups
HTTP Method : GET
Description : Lists entry groups.
Parameters :
pageSize
Type : integer
Format : int32
Location : query
Description : Optional. The maximum number of items to return. Default is 10. Max limit is 1000. Throws an invalid argument for `page_size > 1000`.
parent
Description : Required. The name of the location that contains the entry groups, which can be provided in URL format. Example: * projects/{project_id}/locations/{location}
Location : path
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
pageToken
Location : query
Type : string
Description : Optional. Token that specifies which page is requested. If empty, the first page is returned.
Deprecated : Yes
▼ ▲ datacatalog.projects.locations.entryGroups.setIamPolicy
Description : Sets the access control policy for a resource. Replaces any existing policy. Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog. Callers must have following Google IAM permission - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag templates. - `datacatalog.entries.setIamPolicy` to set policies on entries. - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
Parameters :
resource
Type : string
Required : Yes
Location : path
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$
Deprecated : Yes
Parameter Order : resource
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:setIamPolicy
Path : v1beta1/{+resource}:setIamPolicy
HTTP Method : POST
▼ ▲ datacatalog.projects.locations.entryGroups.get
Description : Gets an EntryGroup.
Parameters :
readMask
Description : The fields to return. If not set or empty, all fields are returned.
Format : google-fieldmask
Location : query
Type : string
name
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$
Location : path
Type : string
Required : Yes
Description : Required. The name of the entry group. For example, `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.
Scopes : https://www.googleapis.com/auth/cloud-platform
Deprecated : Yes
HTTP Method : GET
Parameter Order : name
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}
▼ ▲ datacatalog.projects.locations.entryGroups.entries.tags.create
Parameters :
parent
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$
Location : path
Description : Required. The name of the resource to attach this tag to. Tags can be attached to Entries. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} Note that this Tag and its child resources may not actually be stored in the location in this name.
Required : Yes
Deprecated : Yes
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a tag on an Entry. Note: The project identified by the `parent` parameter for the [tag](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be from the same organization.
HTTP Method : POST
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}/tags
Path : v1beta1/{+parent}/tags
▼ ▲ datacatalog.projects.locations.entryGroups.entries.tags.patch
Deprecated : Yes
Parameters :
updateMask
Location : query
Type : string
Description : Note: Currently, this parameter can only take `"fields"` as value. Names of fields whose values to overwrite on a tag. Currently, a tag has the only modifiable field with the name `fields`. In general, if this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.
Format : google-fieldmask
name
Location : path
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+/tags/[^/]+$
Description : Identifier. The resource name of the tag in URL format. Example: * projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id} where `tag_id` is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates an existing tag.
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}/tags/{tagsId}
HTTP Method : PATCH
Path : v1beta1/{+name}
Parameter Order : name
▼ ▲ datacatalog.projects.locations.entryGroups.entries.tags.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}/tags
Description : Lists tags assigned to an Entry. The columns in the response are lowercased.
HTTP Method : GET
Path : v1beta1/{+parent}/tags
Deprecated : Yes
Parameters :
pageToken
Type : string
Description : Token that specifies which page is requested. If empty, the first page is returned.
Location : query
parent
Required : Yes
Location : path
Description : Required. The name of the Data Catalog resource to list the tags of. The resource could be an Entry or an EntryGroup. Examples: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$
pageSize
Description : The maximum number of tags to return. Default is 10. Max limit is 1000.
Format : int32
Location : query
Type : integer
Parameter Order : parent
▼ ▲ datacatalog.projects.locations.entryGroups.entries.tags.delete
Description : Deletes a tag.
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
Parameter Order : name
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}/tags/{tagsId}
Parameters :
name
Description : Required. The name of the tag to delete. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id}
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+/tags/[^/]+$
Location : path
Type : string
Deprecated : Yes
▼ ▲ datacatalog.projects.locations.entryGroups.entries.patch
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : PATCH
Parameter Order : name
Path : v1beta1/{+name}
Parameters :
name
Required : Yes
Description : Output only. Identifier. The Data Catalog resource name of the entry in URL format. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} Note that this Entry and its child resources may not actually be stored in the location in this name.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$
Location : path
updateMask
Type : string
Location : query
Format : google-fieldmask
Description : Names of fields whose values to overwrite on an entry. If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied. The following fields are modifiable: * For entries with type `DATA_STREAM`: * `schema` * For entries with type `FILESET`: * `schema` * `display_name` * `description` * `gcs_fileset_spec` * `gcs_fileset_spec.file_patterns` * For entries with `user_specified_type`: * `schema` * `display_name` * `description` * `user_specified_type` * `user_specified_system` * `linked_resource` * `source_system_timestamps`
Deprecated : Yes
Description : Updates an existing entry. Users should enable the Data Catalog API in the project identified by the `entry.name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}
▼ ▲ datacatalog.projects.locations.entryGroups.entries.create
Parameter Order : parent
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+parent}/entries
HTTP Method : POST
Parameters :
entryId
Description : Required. The id of the entry to create.
Location : query
Type : string
parent
Required : Yes
Type : string
Location : path
Description : Required. The name of the entry group this entry is in. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} Note that this Entry and its child resources may not actually be stored in the location in this name.
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$
Description : Creates an entry. Only entries of 'FILESET' type or user-specified type can be created. Users should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information). A maximum of 100,000 entries may be created per entry group.
Deprecated : Yes
▼ ▲ datacatalog.projects.locations.entryGroups.entries.get
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$
Description : Required. The name of the entry. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
Location : path
Required : Yes
Deprecated : Yes
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets an entry.
Parameter Order : name
Path : v1beta1/{+name}
▼ ▲ datacatalog.projects.locations.entryGroups.entries.list
Deprecated : Yes
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries
Description : Lists entries.
Parameters :
pageToken
Description : Token that specifies which page is requested. If empty, the first page is returned.
Location : query
Type : string
readMask
Location : query
Format : google-fieldmask
Description : The fields to return for each Entry. If not set or empty, all fields are returned. For example, setting read_mask to contain only one path "name" will cause ListEntries to return a list of Entries with only "name" field.
Type : string
pageSize
Location : query
Description : The maximum number of items to return. Default is 10. Max limit is 1000. Throws an invalid argument for `page_size > 1000`.
Type : integer
Format : int32
parent
Description : Required. The name of the entry group that contains the entries, which can be provided in URL format. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$
Location : path
Type : string
Required : Yes
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Path : v1beta1/{+parent}/entries
▼ ▲ datacatalog.projects.locations.entryGroups.entries.delete
Parameter Order : name
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
Description : Deletes an existing entry. Only entries created through CreateEntry method can be deleted. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
Path : v1beta1/{+name}
Parameters :
name
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$
Description : Required. The name of the entry. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
Location : path
Deprecated : Yes
▼ ▲ datacatalog.projects.locations.entryGroups.entries.getIamPolicy
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:getIamPolicy
Description : Gets the access control policy for a resource. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it. Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog. Callers must have following Google IAM permission - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entries.getIamPolicy` to get policies on entries. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+resource}:getIamPolicy
Parameters :
resource
Location : path
Required : Yes
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$
Type : string
Deprecated : Yes
Parameter Order : resource
▼ ▲ datacatalog.projects.locations.entryGroups.entries.testIamPermissions
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:testIamPermissions
HTTP Method : POST
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
resource
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$
Location : path
Path : v1beta1/{+resource}:testIamPermissions
Deprecated : Yes
Description : Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (We don't return a `NOT_FOUND` error). Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog. A caller is not required to have Google IAM permission to make this request.
▼ ▲ datacatalog.projects.locations.entryGroups.tags.list
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/tags
Path : v1beta1/{+parent}/tags
Description : Lists tags assigned to an Entry. The columns in the response are lowercased.
Parameter Order : parent
Deprecated : Yes
Parameters :
parent
Location : path
Required : Yes
Type : string
Description : Required. The name of the Data Catalog resource to list the tags of. The resource could be an Entry or an EntryGroup. Examples: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$
pageSize
Location : query
Format : int32
Description : The maximum number of tags to return. Default is 10. Max limit is 1000.
Type : integer
pageToken
Type : string
Location : query
Description : Token that specifies which page is requested. If empty, the first page is returned.
▼ ▲ datacatalog.projects.locations.entryGroups.tags.delete
Deprecated : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/tags/{tagsId}
Parameters :
name
Description : Required. The name of the tag to delete. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id}
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/tags/[^/]+$
Type : string
Location : path
Required : Yes
Parameter Order : name
Description : Deletes a tag.
HTTP Method : DELETE
Path : v1beta1/{+name}
▼ ▲ datacatalog.projects.locations.entryGroups.tags.patch
Deprecated : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : Identifier. The resource name of the tag in URL format. Example: * projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id} where `tag_id` is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/tags/[^/]+$
Location : path
Required : Yes
updateMask
Format : google-fieldmask
Location : query
Type : string
Description : Note: Currently, this parameter can only take `"fields"` as value. Names of fields whose values to overwrite on a tag. Currently, a tag has the only modifiable field with the name `fields`. In general, if this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.
Path : v1beta1/{+name}
Description : Updates an existing tag.
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/tags/{tagsId}
HTTP Method : PATCH
Parameter Order : name
▼ ▲ datacatalog.projects.locations.entryGroups.tags.create
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a tag on an Entry. Note: The project identified by the `parent` parameter for the [tag](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be from the same organization.
Deprecated : Yes
Parameters :
parent
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$
Description : Required. The name of the resource to attach this tag to. Tags can be attached to Entries. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} Note that this Tag and its child resources may not actually be stored in the location in this name.
Parameter Order : parent
Path : v1beta1/{+parent}/tags
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/tags
▼ ▲ datacatalog.projects.locations.tagTemplates.fields.enumValues.rename
Deprecated : Yes
Parameters :
name
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+/fields/[^/]+/enumValues/[^/]+$
Description : Required. The name of the enum field value. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}/enumValues/{enum_value_display_name}
Parameter Order : name
HTTP Method : POST
Description : Renames an enum value in a tag template. The enum values have to be unique within one enum field. Thus, an enum value cannot be renamed with a name used in any other enum value within the same enum field.
Path : v1beta1/{+name}:rename
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}/fields/{fieldsId}/enumValues/{enumValuesId}:rename
▼ ▲ datacatalog.projects.locations.tagTemplates.fields.rename
Deprecated : Yes
Path : v1beta1/{+name}:rename
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Type : string
Location : path
Description : Required. The name of the tag template. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}
Pattern : ^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+/fields/[^/]+$
Required : Yes
Parameter Order : name
HTTP Method : POST
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}/fields/{fieldsId}:rename
Description : Renames a field in a tag template. The user should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
▼ ▲ datacatalog.projects.locations.tagTemplates.fields.create
Parameter Order : parent
Parameters :
parent
Type : string
Location : path
Description : Required. The name of the project and the template location [region](https://cloud.google.com/data-catalog/docs/concepts/regions). Example: * projects/{project_id}/locations/us-central1/tagTemplates/{tag_template_id}
Pattern : ^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+$
Required : Yes
tagTemplateFieldId
Location : query
Type : string
Description : Required. The ID of the tag template field to create. Field ids can contain letters (both uppercase and lowercase), numbers (0-9), underscores (_) and dashes (-). Field IDs must be at least 1 character long and at most 128 characters long. Field IDs must also be unique within their template.
Deprecated : Yes
Path : v1beta1/{+parent}/fields
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}/fields
Description : Creates a field in a tag template. The user should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
▼ ▲ datacatalog.projects.locations.tagTemplates.fields.patch
HTTP Method : PATCH
Path : v1beta1/{+name}
Deprecated : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}/fields/{fieldsId}
Parameters :
name
Description : Required. The name of the tag template field. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+/fields/[^/]+$
Location : path
updateMask
Description : Optional. Names of fields whose values to overwrite on an individual field of a tag template. The following fields are modifiable: * `display_name` * `type.enum_type` * `is_required` If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied with one exception: when updating an enum type, the provided values are merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted or renamed. Additionally, updating a template field from optional to required is *not* allowed.
Location : query
Type : string
Format : google-fieldmask
Description : Updates a field in a tag template. This method cannot be used to update the field type. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
▼ ▲ datacatalog.projects.locations.tagTemplates.fields.delete
HTTP Method : DELETE
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}/fields/{fieldsId}
Path : v1beta1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Deprecated : Yes
Parameters :
force
Description : Required. Currently, this field must always be set to `true`. This confirms the deletion of this field from any tags using this field. `force = false` will be supported in the future.
Location : query
Type : boolean
name
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+/fields/[^/]+$
Description : Required. The name of the tag template field to delete. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}
Description : Deletes a field in a tag template and all uses of that field. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
▼ ▲ datacatalog.projects.locations.tagTemplates.setIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}:setIamPolicy
Description : Sets the access control policy for a resource. Replaces any existing policy. Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog. Callers must have following Google IAM permission - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag templates. - `datacatalog.entries.setIamPolicy` to set policies on entries. - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
Deprecated : Yes
Path : v1beta1/{+resource}:setIamPolicy
Parameter Order : resource
Parameters :
resource
Type : string
Location : path
Required : Yes
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+$
▼ ▲ datacatalog.projects.locations.tagTemplates.delete
Parameter Order : name
HTTP Method : DELETE
Description : Deletes a tag template and all tags using the template. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
Deprecated : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+$
Required : Yes
Description : Required. The name of the tag template to delete. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}
Location : path
Type : string
force
Type : boolean
Description : Required. Currently, this field must always be set to `true`. This confirms the deletion of any possible tags using this template. `force = false` will be supported in the future.
Location : query
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}
Path : v1beta1/{+name}
▼ ▲ datacatalog.projects.locations.tagTemplates.create
Parameter Order : parent
Path : v1beta1/{+parent}/tagTemplates
HTTP Method : POST
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tagTemplates
Description : Creates a tag template. The user should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
tagTemplateId
Description : Required. The id of the tag template to create.
Location : query
Type : string
parent
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Description : Required. The name of the project and the template location [region](https://cloud.google.com/data-catalog/docs/concepts/regions. Example: * projects/{project_id}/locations/us-central1
Deprecated : Yes
▼ ▲ datacatalog.projects.locations.tagTemplates.get
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The name of the tag template. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}
Deprecated : Yes
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}
Description : Gets a tag template.
▼ ▲ datacatalog.projects.locations.tagTemplates.testIamPermissions
Parameter Order : resource
Path : v1beta1/{+resource}:testIamPermissions
HTTP Method : POST
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}:testIamPermissions
Description : Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (We don't return a `NOT_FOUND` error). Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog. A caller is not required to have Google IAM permission to make this request.
Parameters :
resource
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+$
Required : Yes
Type : string
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Deprecated : Yes
▼ ▲ datacatalog.projects.locations.tagTemplates.patch
Description : Updates a tag template. This method cannot be used to update the fields of a template. The tag template fields are represented as separate resources and should be updated using their own create/update/delete methods. Users should enable the Data Catalog API in the project identified by the `tag_template.name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}
HTTP Method : PATCH
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+$
Required : Yes
Description : Identifier. The resource name of the tag template in URL format. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id} Note that this TagTemplate and its child resources may not actually be stored in the location in this name.
Type : string
updateMask
Format : google-fieldmask
Type : string
Description : Names of fields whose values to overwrite on a tag template. Currently, only `display_name` can be overwritten. In general, if this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.
Location : query
Deprecated : Yes
Path : v1beta1/{+name}
▼ ▲ datacatalog.projects.locations.tagTemplates.getIamPolicy
HTTP Method : POST
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}:getIamPolicy
Description : Gets the access control policy for a resource. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it. Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog. Callers must have following Google IAM permission - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entries.getIamPolicy` to get policies on entries. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+$
Parameter Order : resource
Deprecated : Yes
Path : v1beta1/{+resource}:getIamPolicy
▼ ▲ datacatalog.entries.lookup
HTTP Method : GET
Path : v1beta1/entries:lookup
Description : Get an entry by target resource name. This method allows clients to use the resource name from the source Google Cloud Platform service to get the Data Catalog Entry.
Deprecated : Yes
Flat Path : v1beta1/entries:lookup
Parameters :
linkedResource
Description : The full name of the Google Cloud Platform resource the Data Catalog entry represents. See: https://cloud.google.com/apis/design/resource_names#full_resource_name. Full names are case-sensitive. Examples: * //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId * //pubsub.googleapis.com/projects/projectId/topics/topicId
Location : query
Type : string
sqlResource
Type : string
Description : The SQL name of the entry. SQL names are case-sensitive. Examples: * `pubsub.project_id.topic_id` * ``pubsub.project_id.`topic.id.with.dots` `` * `bigquery.table.project_id.dataset_id.table_id` * `bigquery.dataset.project_id.dataset_id` * `datacatalog.entry.project_id.location_id.entry_group_id.entry_id` `*_id`s should satisfy the GoogleSQL rules for identifiers. https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical.
Location : query