2026-11-07
▼ ▲ datacatalog.entries.lookup
Deprecated : Yes
Flat Path : v1/entries:lookup
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/entries:lookup
HTTP Method : GET
Parameters :
linkedResource
Description : The full name of the Google Cloud Platform resource the Data Catalog entry represents. For more information, see [Full Resource Name] (https://cloud.google.com/apis/design/resource_names#full_resource_name). Full names are case-sensitive. For example: * `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}` * `//pubsub.googleapis.com/projects/{PROJECT_ID}/topics/{TOPIC_ID}`
Location : query
Type : string
fullyQualifiedName
Location : query
Description : [Fully Qualified Name (FQN)](https://cloud.google.com//data-catalog/docs/fully-qualified-names) of the resource. FQNs take two forms: * For non-regionalized resources: `{SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}` * For regionalized resources: `{SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}` Example for a DPMS table: `dataproc_metastore:{PROJECT_ID}.{LOCATION_ID}.{INSTANCE_ID}.{DATABASE_ID}.{TABLE_ID}`
Type : string
project
Type : string
Location : query
Description : Project where the lookup should be performed. Required to lookup entry that is not a part of `DPMS` or `DATAPLEX` `integrated_system` using its `fully_qualified_name`. Ignored in other cases.
sqlResource
Description : The SQL name of the entry. SQL names are case-sensitive. Examples: * `pubsub.topic.{PROJECT_ID}.{TOPIC_ID}` * `pubsub.topic.{PROJECT_ID}.`\``{TOPIC.ID.SEPARATED.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}` Identifiers (`*_ID`) should comply with the [Lexical structure in GoogleSQL] (https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical).
Location : query
Type : string
location
Location : query
Type : string
Description : Location where the lookup should be performed. Required to lookup entry that is not a part of `DPMS` or `DATAPLEX` `integrated_system` using its `fully_qualified_name`. Ignored in other cases.
Description : Gets an entry by its target resource name. The resource name comes from the source Google Cloud Platform service.
▼ ▲ datacatalog.projects.locations.tagTemplates.get
Deprecated : Yes
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
Description : Gets a tag template.
Parameter Order : name
HTTP Method : GET
Parameters :
name
Location : path
Type : string
Description : Required. The name of the tag template to get.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+$
▼ ▲ datacatalog.projects.locations.tagTemplates.delete
Parameter Order : name
Deprecated : Yes
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}
Description : Deletes a tag template and all tags that use it. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the tag template to delete.
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+$
force
Type : boolean
Location : query
Description : Required. If true, deletes all tags that use this template. Currently, `true` is the only supported value.
▼ ▲ datacatalog.projects.locations.tagTemplates.getIamPolicy
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Deprecated : Yes
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}:getIamPolicy
HTTP Method : POST
Parameters :
resource
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+$
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.
Path : v1/{+resource}:getIamPolicy
Description : Gets the access control policy for a resource. May return: * A`NOT_FOUND` error if the resource doesn't exist or you don't have the permission to view it. * An empty policy if the resource exists but doesn't have a set policy. Supported resources are: - Tag templates - Entry groups Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog. To call this method, you must have the following Google IAM permissions: - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
▼ ▲ datacatalog.projects.locations.tagTemplates.patch
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}
Deprecated : Yes
Description : Updates a tag template. You can't update template fields with this method. These fields are separate resources with their own create, update, and delete methods. You must enable the Data Catalog API in the project identified by the `tag_template.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Path : v1/{+name}
HTTP Method : PATCH
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+$
Description : Identifier. The resource name of the tag template in URL format. Note: The tag template itself and its child resources might not be stored in the location specified in its name.
Required : Yes
Location : path
Type : string
updateMask
Description : Names of fields whose values to overwrite on a tag template. Currently, only `display_name` and `is_publicly_readable` can be overwritten. 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. Note: Updating the `is_publicly_readable` field may require up to 12 hours to take effect in search results.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
▼ ▲ datacatalog.projects.locations.tagTemplates.create
HTTP Method : POST
Parameters :
tagTemplateId
Description : Required. The ID of the tag template to create. The ID must contain only lowercase letters (a-z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8.
Location : query
Type : string
parent
Description : Required. The name of the project and the template location [region](https://cloud.google.com/data-catalog/docs/concepts/regions).
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Description : Creates a tag template. You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Path : v1/{+parent}/tagTemplates
Deprecated : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/tagTemplates
▼ ▲ datacatalog.projects.locations.tagTemplates.testIamPermissions
Parameter Order : resource
HTTP Method : POST
Parameters :
resource
Location : path
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.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+resource}:testIamPermissions
Deprecated : Yes
Description : Gets your permissions on a resource. Returns an empty set of permissions if the resource doesn't exist. Supported resources are: - Tag templates - Entry groups Note: This method gets policies only within Data Catalog and can't be used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources ingested into Data Catalog. No Google IAM permissions are required to call this method.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}:testIamPermissions
▼ ▲ datacatalog.projects.locations.tagTemplates.setIamPolicy
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+resource}:setIamPolicy
HTTP Method : POST
Parameters :
resource
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.
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+$
Location : path
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}:setIamPolicy
Deprecated : Yes
Description : Sets an access control policy for a resource. Replaces any existing policy. Supported resources are: - Tag templates - Entry groups Note: This method sets policies only within Data Catalog and can't be used to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources synced with the Data Catalog. To call this method, you must have the following Google IAM permissions: - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag templates. - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
▼ ▲ datacatalog.projects.locations.tagTemplates.fields.enumValues.rename
Deprecated : Yes
HTTP Method : POST
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+/fields/[^/]+/enumValues/[^/]+$
Type : string
Description : Required. The name of the enum field value.
Required : Yes
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}/fields/{fieldsId}/enumValues/{enumValuesId}:rename
Path : v1/{+name}:rename
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Renames an enum value in a tag template. Within a single enum field, enum values must be unique.
▼ ▲ datacatalog.projects.locations.tagTemplates.fields.rename
HTTP Method : POST
Parameters :
name
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+/fields/[^/]+$
Description : Required. The name of the tag template field.
Location : path
Path : v1/{+name}:rename
Description : Renames a field in a tag template. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Scopes : https://www.googleapis.com/auth/cloud-platform
Deprecated : Yes
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}/fields/{fieldsId}:rename
▼ ▲ datacatalog.projects.locations.tagTemplates.fields.create
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}/fields
Description : Creates a field in a tag template. You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
HTTP Method : POST
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+$
Required : Yes
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).
tagTemplateFieldId
Type : string
Description : Required. The ID of the tag template field to create. Note: Adding a required field to an existing template is *not* allowed. 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.
Location : query
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+parent}/fields
Deprecated : Yes
Parameter Order : parent
▼ ▲ datacatalog.projects.locations.tagTemplates.fields.delete
HTTP Method : DELETE
Parameters :
force
Location : query
Description : Required. If true, deletes this field from any tags that use it. Currently, `true` is the only supported value.
Type : boolean
name
Pattern : ^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+/fields/[^/]+$
Required : Yes
Type : string
Description : Required. The name of the tag template field to delete.
Location : path
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}/fields/{fieldsId}
Description : Deletes a field in a tag template and all uses of this field from the tags based on this template. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Deprecated : Yes
▼ ▲ datacatalog.projects.locations.tagTemplates.fields.patch
Path : v1/{+name}
HTTP Method : PATCH
Parameters :
updateMask
Format : google-fieldmask
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.
Type : string
Location : query
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+/fields/[^/]+$
Type : string
Description : Required. The name of the tag template field.
Location : path
Parameter Order : name
Deprecated : Yes
Description : Updates a field in a tag template. You can't update the field type with this method. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}/fields/{fieldsId}
▼ ▲ datacatalog.projects.locations.entryGroups.create
Parameter Order : parent
Description : Creates an entry group. An entry group contains logically related entries together with [Cloud Identity and Access Management](/data-catalog/docs/concepts/iam) policies. These policies specify users who can create, edit, and view entries within entry groups. Data Catalog automatically creates entry groups with names that start with the `@` symbol for the following resources: * BigQuery entries (`@bigquery`) * Pub/Sub topics (`@pubsub`) * Dataproc Metastore services (`@dataproc_metastore_{SERVICE_NAME_HASH}`) You can create your own entry groups for Cloud Storage fileset entries and custom entries together with the corresponding IAM policies. User-created entry groups can't contain the `@` symbol, it is reserved for automatically created groups. Entry groups, like entries, can be searched. A maximum of 10,000 entry groups may be created per organization across all locations. You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Deprecated : Yes
HTTP Method : POST
Parameters :
parent
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. The names of the project and location that the new entry group belongs to. Note: The entry group itself and its child resources might not be stored in the location specified in its name.
Location : path
Required : Yes
entryGroupId
Type : string
Description : Required. The ID of the entry group to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8.
Location : query
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups
Path : v1/{+parent}/entryGroups
▼ ▲ datacatalog.projects.locations.entryGroups.getIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : resource
Deprecated : Yes
Path : v1/{+resource}:getIamPolicy
Description : Gets the access control policy for a resource. May return: * A`NOT_FOUND` error if the resource doesn't exist or you don't have the permission to view it. * An empty policy if the resource exists but doesn't have a set policy. Supported resources are: - Tag templates - Entry groups Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog. To call this method, you must have the following Google IAM permissions: - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
HTTP Method : POST
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/[^/]+/entryGroups/[^/]+$
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:getIamPolicy
▼ ▲ datacatalog.projects.locations.entryGroups.get
Description : Gets an entry group.
HTTP Method : GET
Parameters :
name
Location : path
Description : Required. The name of the entry group to get.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$
Required : Yes
readMask
Location : query
Format : google-fieldmask
Type : string
Description : The fields to return. If empty or omitted, all fields are returned.
Deprecated : Yes
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}
Parameter Order : name
Path : v1/{+name}
▼ ▲ datacatalog.projects.locations.entryGroups.setIamPolicy
HTTP Method : POST
Parameters :
resource
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.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$
Required : Yes
Description : Sets an access control policy for a resource. Replaces any existing policy. Supported resources are: - Tag templates - Entry groups Note: This method sets policies only within Data Catalog and can't be used to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources synced with the Data Catalog. To call this method, you must have the following Google IAM permissions: - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag templates. - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+resource}:setIamPolicy
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:setIamPolicy
Deprecated : Yes
▼ ▲ datacatalog.projects.locations.entryGroups.patch
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}
HTTP Method : PATCH
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$
Type : string
Location : path
Required : Yes
Description : Identifier. The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name.
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
Description : Updates an entry group. You must enable the Data Catalog API in the project identified by the `entry_group.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Deprecated : Yes
Path : v1/{+name}
Parameter Order : name
▼ ▲ datacatalog.projects.locations.entryGroups.list
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups
Path : v1/{+parent}/entryGroups
HTTP Method : GET
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Description : Required. The name of the location that contains the entry groups to list. Can be provided as a URL.
Type : string
pageSize
Format : int32
Description : Optional. The maximum number of items to return. Default is 10. Maximum limit is 1000. Throws an invalid argument if `page_size` is greater than 1000.
Type : integer
Location : query
pageToken
Type : string
Description : Optional. Pagination token that specifies the next page to return. If empty, returns the first page.
Location : query
Scopes : https://www.googleapis.com/auth/cloud-platform
Deprecated : Yes
Description : Lists entry groups.
Parameter Order : parent
▼ ▲ datacatalog.projects.locations.entryGroups.testIamPermissions
Path : v1/{+resource}:testIamPermissions
Description : Gets your permissions on a resource. Returns an empty set of permissions if the resource doesn't exist. Supported resources are: - Tag templates - Entry groups Note: This method gets policies only within Data Catalog and can't be used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources ingested into Data Catalog. No Google IAM permissions are required to call this method.
Parameter Order : resource
HTTP Method : POST
Parameters :
resource
Location : path
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.
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$
Required : Yes
Type : string
Deprecated : Yes
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:testIamPermissions
▼ ▲ datacatalog.projects.locations.entryGroups.delete
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}
Parameter Order : name
Deprecated : Yes
HTTP Method : DELETE
Parameters :
name
Location : path
Description : Required. The name of the entry group to delete.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$
Required : Yes
force
Location : query
Description : Optional. If true, deletes all entries in the entry group.
Type : boolean
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
Description : Deletes an entry group. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
▼ ▲ datacatalog.projects.locations.entryGroups.entries.star
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Description : Marks an Entry as starred by the current user. Starring information is private to each user.
Deprecated : Yes
Path : v1/{+name}:star
HTTP Method : POST
Parameters :
name
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$
Description : Required. The name of the entry to mark as starred.
Required : Yes
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:star
▼ ▲ datacatalog.projects.locations.entryGroups.entries.get
Description : Gets an entry.
Path : v1/{+name}
Deprecated : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the entry to get.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$
Required : Yes
Type : string
Parameter Order : name
▼ ▲ datacatalog.projects.locations.entryGroups.entries.getIamPolicy
Description : Gets the access control policy for a resource. May return: * A`NOT_FOUND` error if the resource doesn't exist or you don't have the permission to view it. * An empty policy if the resource exists but doesn't have a set policy. Supported resources are: - Tag templates - Entry groups Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog. To call this method, you must have the following Google IAM permissions: - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
Path : v1/{+resource}:getIamPolicy
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:getIamPolicy
HTTP Method : POST
Parameters :
resource
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$
Location : path
Required : Yes
Type : string
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.
Parameter Order : resource
Deprecated : Yes
▼ ▲ datacatalog.projects.locations.entryGroups.entries.testIamPermissions
Description : Gets your permissions on a resource. Returns an empty set of permissions if the resource doesn't exist. Supported resources are: - Tag templates - Entry groups Note: This method gets policies only within Data Catalog and can't be used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources ingested into Data Catalog. No Google IAM permissions are required to call this method.
Path : v1/{+resource}:testIamPermissions
Deprecated : Yes
HTTP Method : POST
Parameters :
resource
Type : string
Required : Yes
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/[^/]+/entries/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : resource
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:testIamPermissions
▼ ▲ datacatalog.projects.locations.entryGroups.entries.create
Deprecated : Yes
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+parent}/entries
HTTP Method : POST
Parameters :
parent
Type : string
Description : 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.
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$
entryId
Description : 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.
Type : string
Location : query
Description : 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](https://cloud.google.com/data-catalog/docs/concepts/resource-project). An entry group can have a maximum of 100,000 entries.
▼ ▲ datacatalog.projects.locations.entryGroups.entries.modifyEntryOverview
Scopes : https://www.googleapis.com/auth/cloud-platform
Deprecated : Yes
HTTP Method : POST
Parameters :
name
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$
Description : Required. The full resource name of the entry.
Type : string
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:modifyEntryOverview
Path : v1/{+name}:modifyEntryOverview
Description : Modifies entry overview, part of the business context of an Entry. To call this method, you must have the `datacatalog.entries.updateOverview` IAM permission on the corresponding project.
▼ ▲ datacatalog.projects.locations.entryGroups.entries.modifyEntryContacts
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:modifyEntryContacts
HTTP Method : POST
Parameters :
name
Location : path
Type : string
Description : Required. The full resource name of the entry.
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$
Required : Yes
Description : Modifies contacts, part of the business context of an Entry. To call this method, you must have the `datacatalog.entries.updateContacts` IAM permission on the corresponding project.
Path : v1/{+name}:modifyEntryContacts
Deprecated : Yes
Parameter Order : name
▼ ▲ datacatalog.projects.locations.entryGroups.entries.unstar
Parameter Order : name
Description : Marks an Entry as NOT starred by the current user. Starring information is private to each user.
Path : v1/{+name}:unstar
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$
Description : Required. The name of the entry to mark as **not** starred.
Type : string
Location : path
Deprecated : Yes
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:unstar
▼ ▲ datacatalog.projects.locations.entryGroups.entries.import
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Parameters :
parent
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$
Description : Required. Target entry group for ingested entries.
Type : string
Location : path
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries:import
Path : v1/{+parent}/entries:import
Description : Imports entries from a source, such as data previously dumped into a Cloud Storage bucket, into Data Catalog. Import of entries is a sync operation that reconciles the state of the third-party system with the Data Catalog. `ImportEntries` accepts source data snapshots of a third-party system. Snapshot should be delivered as a .wire or base65-encoded .txt file containing a sequence of Protocol Buffer messages of DumpItem type. `ImportEntries` returns a long-running operation resource that can be queried with Operations.GetOperation to return ImportEntriesMetadata and an ImportEntriesResponse message.
Parameter Order : parent
Deprecated : Yes
▼ ▲ datacatalog.projects.locations.entryGroups.entries.delete
Deprecated : Yes
Path : v1/{+name}
Description : Deletes an existing entry. You can delete only the entries created by the CreateEntry method. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}
HTTP Method : DELETE
Parameters :
name
Required : Yes
Type : string
Description : Required. The name of the entry to delete.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$
▼ ▲ datacatalog.projects.locations.entryGroups.entries.list
Description : Lists entries. Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use SearchCatalog.
HTTP Method : GET
Parameters :
parent
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$
Description : Required. The name of the entry group that contains the entries to list. Can be provided in URL format.
pageSize
Description : The maximum number of items to return. Default is 10. Maximum limit is 1000. Throws an invalid argument if `page_size` is more than 1000.
Type : integer
Format : int32
Location : query
readMask
Format : google-fieldmask
Location : query
Description : The fields to return for each entry. If empty or omitted, all fields are returned. For example, to return a list of entries with only the `name` field, set `read_mask` to only one path with the `name` value.
Type : string
pageToken
Description : Pagination token that specifies the next page to return. If empty, the first page is returned.
Location : query
Type : string
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries
Parameter Order : parent
Deprecated : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+parent}/entries
▼ ▲ datacatalog.projects.locations.entryGroups.entries.patch
HTTP Method : PATCH
Parameters :
name
Description : 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.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$
Required : Yes
Type : string
updateMask
Type : string
Format : google-fieldmask
Location : query
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. You can modify only the fields listed below. 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`
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}
Description : Updates an existing entry. You must enable the Data Catalog API in the project identified by the `entry.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Deprecated : Yes
▼ ▲ datacatalog.projects.locations.entryGroups.entries.tags.patch
Path : v1/{+name}
Parameter Order : name
Deprecated : Yes
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}/tags/{tagsId}
HTTP Method : PATCH
Parameters :
updateMask
Description : 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.
Type : string
Location : query
Format : google-fieldmask
name
Description : Identifier. The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+/tags/[^/]+$
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates an existing tag.
▼ ▲ datacatalog.projects.locations.entryGroups.entries.tags.create
Deprecated : Yes
Path : v1/{+parent}/tags
HTTP Method : POST
Parameters :
parent
Location : path
Description : Required. The name of the resource to attach this tag to. Tags can be attached to entries or entry groups. An entry can have up to 1000 attached tags. Note: The tag and its child resources might not be stored in the location specified in its name.
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a tag and assigns it to: * An Entry if the method name is `projects.locations.entryGroups.entries.tags.create`. * Or EntryGroupif the method name is `projects.locations.entryGroups.tags.create`. Note: The project identified by the `parent` parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}/tags
Parameter Order : parent
▼ ▲ datacatalog.projects.locations.entryGroups.entries.tags.reconcile
HTTP Method : POST
Parameters :
parent
Description : Required. Name of Entry to be tagged.
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$
Path : v1/{+parent}/tags:reconcile
Parameter Order : parent
Description : `ReconcileTags` creates or updates a list of tags on the entry. If the ReconcileTagsRequest.force_delete_missing parameter is set, the operation deletes tags not included in the input tag list. `ReconcileTags` returns a long-running operation resource that can be queried with Operations.GetOperation to return ReconcileTagsMetadata and a ReconcileTagsResponse message. Note: SearchCatalog might return stale search results for up to 24 hours after the `ReconcileTags` operation completes.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}/tags:reconcile
Deprecated : Yes
▼ ▲ datacatalog.projects.locations.entryGroups.entries.tags.list
HTTP Method : GET
Parameters :
pageToken
Description : Pagination token that specifies the next page to return. If empty, the first page is returned.
Location : query
Type : string
pageSize
Format : int32
Type : integer
Description : The maximum number of tags to return. Default is 10. Maximum limit is 1000.
Location : query
parent
Description : Required. The name of the Data Catalog resource to list the tags of. The resource can be an Entry or an EntryGroup (without `/entries/{entries}` at the end).
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$
Type : string
Required : Yes
Description : Lists tags assigned to an Entry. The columns in the response are lowercased.
Path : v1/{+parent}/tags
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}/tags
Parameter Order : parent
Deprecated : Yes
▼ ▲ datacatalog.projects.locations.entryGroups.entries.tags.delete
Description : Deletes a tag.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}/tags/{tagsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the tag to delete.
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+/tags/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
Deprecated : Yes
Parameter Order : name
Path : v1/{+name}
▼ ▲ datacatalog.projects.locations.entryGroups.tags.patch
HTTP Method : PATCH
Parameters :
name
Location : path
Description : Identifier. The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name.
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/tags/[^/]+$
Required : Yes
Type : string
updateMask
Location : query
Format : google-fieldmask
Type : string
Description : 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.
Scopes : https://www.googleapis.com/auth/cloud-platform
Deprecated : Yes
Parameter Order : name
Description : Updates an existing tag.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/tags/{tagsId}
Path : v1/{+name}
▼ ▲ datacatalog.projects.locations.entryGroups.tags.list
Description : Lists tags assigned to an Entry. The columns in the response are lowercased.
HTTP Method : GET
Parameters :
pageToken
Location : query
Description : Pagination token that specifies the next page to return. If empty, the first page is returned.
Type : string
pageSize
Location : query
Type : integer
Description : The maximum number of tags to return. Default is 10. Maximum limit is 1000.
Format : int32
parent
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$
Required : Yes
Location : path
Type : string
Description : Required. The name of the Data Catalog resource to list the tags of. The resource can be an Entry or an EntryGroup (without `/entries/{entries}` at the end).
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+parent}/tags
Deprecated : Yes
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/tags
▼ ▲ datacatalog.projects.locations.entryGroups.tags.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/tags/{tagsId}
HTTP Method : DELETE
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/tags/[^/]+$
Description : Required. The name of the tag to delete.
Type : string
Required : Yes
Description : Deletes a tag.
Deprecated : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
▼ ▲ datacatalog.projects.locations.entryGroups.tags.create
HTTP Method : POST
Parameters :
parent
Description : Required. The name of the resource to attach this tag to. Tags can be attached to entries or entry groups. An entry can have up to 1000 attached tags. Note: The tag and its child resources might not be stored in the location specified in its name.
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/tags
Description : Creates a tag and assigns it to: * An Entry if the method name is `projects.locations.entryGroups.entries.tags.create`. * Or EntryGroupif the method name is `projects.locations.entryGroups.tags.create`. Note: The project identified by the `parent` parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization.
Path : v1/{+parent}/tags
Scopes : https://www.googleapis.com/auth/cloud-platform
Deprecated : Yes
Parameter Order : parent