Google Cloud Data Catalog API: projects. A fully managed and highly scalable data discovery and metadata management service.
See: https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects
Google Cloud Data Catalog API: projects. A fully managed and highly scalable data discovery and metadata management service. See: https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects
(locations-entryGroups-create$ auth args body)
Required parameters: parent
Optional parameters: entryGroupId
Body:
{:dataCatalogTimestamps {:createTime string, :expireTime string, :updateTime string}, :name string, :displayName string, :description string}
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]
(/data-catalog/docs/concepts/resource-project) for more information).
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/entryGroups/create Required parameters: parent Optional parameters: entryGroupId Body: {:dataCatalogTimestamps {:createTime string, :expireTime string, :updateTime string}, :name string, :displayName string, :description string} 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] (/data-catalog/docs/concepts/resource-project) for more information).
(locations-entryGroups-delete$ auth args)
Required parameters: name
Optional parameters: force
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]
(/data-catalog/docs/concepts/resource-project) for more information).
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/entryGroups/delete Required parameters: name Optional parameters: force 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] (/data-catalog/docs/concepts/resource-project) for more information).
(locations-entryGroups-entries-create$ auth args body)
Required parameters: parent
Optional parameters: entryId
Body:
{:description string, :schema {:columns [GoogleCloudDatacatalogV1beta1ColumnSchema]}, :bigqueryDateShardedSpec {:tablePrefix string, :shardCount string, :dataset string}, :userSpecifiedSystem string, :sourceSystemTimestamps {:createTime string, :expireTime string, :updateTime string}, :displayName string, :name string, :gcsFilesetSpec {:filePatterns [string], :sampleGcsFileSpecs [GoogleCloudDatacatalogV1beta1GcsFileSpec]}, :type string, :bigqueryTableSpec {:tableSpec GoogleCloudDatacatalogV1beta1TableSpec, :tableSourceType string, :viewSpec GoogleCloudDatacatalogV1beta1ViewSpec}, :linkedResource string, :userSpecifiedType string, :integratedSystem string}
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]
(/data-catalog/docs/concepts/resource-project) for more information).
A maximum of 100,000 entries may be created per entry group.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/entryGroups/entries/create Required parameters: parent Optional parameters: entryId Body: {:description string, :schema {:columns [GoogleCloudDatacatalogV1beta1ColumnSchema]}, :bigqueryDateShardedSpec {:tablePrefix string, :shardCount string, :dataset string}, :userSpecifiedSystem string, :sourceSystemTimestamps {:createTime string, :expireTime string, :updateTime string}, :displayName string, :name string, :gcsFilesetSpec {:filePatterns [string], :sampleGcsFileSpecs [GoogleCloudDatacatalogV1beta1GcsFileSpec]}, :type string, :bigqueryTableSpec {:tableSpec GoogleCloudDatacatalogV1beta1TableSpec, :tableSourceType string, :viewSpec GoogleCloudDatacatalogV1beta1ViewSpec}, :linkedResource string, :userSpecifiedType string, :integratedSystem string} 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] (/data-catalog/docs/concepts/resource-project) for more information). A maximum of 100,000 entries may be created per entry group.
(locations-entryGroups-entries-delete$ auth args)
Required parameters: name
Optional parameters: none
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]
(/data-catalog/docs/concepts/resource-project) for more information).
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/entryGroups/entries/delete Required parameters: name Optional parameters: none 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] (/data-catalog/docs/concepts/resource-project) for more information).
(locations-entryGroups-entries-get$ auth args)
Required parameters: name
Optional parameters: none Gets an entry.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/entryGroups/entries/get Required parameters: name Optional parameters: none Gets an entry.
(locations-entryGroups-entries-getIamPolicy$ auth args body)
Required parameters: resource
Optional parameters: none
Body:
{:options {:requestedPolicyVersion integer}}
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:
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.https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/entryGroups/entries/getIamPolicy Required parameters: resource Optional parameters: none Body: {:options {:requestedPolicyVersion integer}} 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, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud 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.
(locations-entryGroups-entries-list$ auth args)
Required parameters: parent
Optional parameters: readMask, pageToken, pageSize Lists entries.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/entryGroups/entries/list Required parameters: parent Optional parameters: readMask, pageToken, pageSize Lists entries.
(locations-entryGroups-entries-patch$ auth args body)
Required parameters: name
Optional parameters: updateMask
Body:
{:description string, :schema {:columns [GoogleCloudDatacatalogV1beta1ColumnSchema]}, :bigqueryDateShardedSpec {:tablePrefix string, :shardCount string, :dataset string}, :userSpecifiedSystem string, :sourceSystemTimestamps {:createTime string, :expireTime string, :updateTime string}, :displayName string, :name string, :gcsFilesetSpec {:filePatterns [string], :sampleGcsFileSpecs [GoogleCloudDatacatalogV1beta1GcsFileSpec]}, :type string, :bigqueryTableSpec {:tableSpec GoogleCloudDatacatalogV1beta1TableSpec, :tableSourceType string, :viewSpec GoogleCloudDatacatalogV1beta1ViewSpec}, :linkedResource string, :userSpecifiedType string, :integratedSystem string}
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]
(/data-catalog/docs/concepts/resource-project) for more information).
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/entryGroups/entries/patch Required parameters: name Optional parameters: updateMask Body: {:description string, :schema {:columns [GoogleCloudDatacatalogV1beta1ColumnSchema]}, :bigqueryDateShardedSpec {:tablePrefix string, :shardCount string, :dataset string}, :userSpecifiedSystem string, :sourceSystemTimestamps {:createTime string, :expireTime string, :updateTime string}, :displayName string, :name string, :gcsFilesetSpec {:filePatterns [string], :sampleGcsFileSpecs [GoogleCloudDatacatalogV1beta1GcsFileSpec]}, :type string, :bigqueryTableSpec {:tableSpec GoogleCloudDatacatalogV1beta1TableSpec, :tableSourceType string, :viewSpec GoogleCloudDatacatalogV1beta1ViewSpec}, :linkedResource string, :userSpecifiedType string, :integratedSystem string} 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] (/data-catalog/docs/concepts/resource-project) for more information).
(locations-entryGroups-entries-tags-create$ auth args body)
Required parameters: parent
Optional parameters: none
Body:
{:column string, :template string, :templateDisplayName string, :fields {}, :name string}
Creates a tag on an Entry.
Note: The project identified by the parent
parameter for the
tag
and the
tag
template
used to create the tag must be from the same organization.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/entryGroups/entries/tags/create Required parameters: parent Optional parameters: none Body: {:column string, :template string, :templateDisplayName string, :fields {}, :name string} Creates a tag on an Entry. Note: The project identified by the `parent` parameter for the [tag](/data-catalog/docs/reference/rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template](/data-catalog/docs/reference/rest/v1beta1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be from the same organization.
(locations-entryGroups-entries-tags-delete$ auth args)
Required parameters: name
Optional parameters: none Deletes a tag.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/entryGroups/entries/tags/delete Required parameters: name Optional parameters: none Deletes a tag.
(locations-entryGroups-entries-tags-list$ auth args)
Required parameters: parent
Optional parameters: pageSize, pageToken Lists the tags on an Entry.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/entryGroups/entries/tags/list Required parameters: parent Optional parameters: pageSize, pageToken Lists the tags on an Entry.
(locations-entryGroups-entries-tags-patch$ auth args body)
Required parameters: name
Optional parameters: updateMask
Body:
{:column string, :template string, :templateDisplayName string, :fields {}, :name string}
Updates an existing tag.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/entryGroups/entries/tags/patch Required parameters: name Optional parameters: updateMask Body: {:column string, :template string, :templateDisplayName string, :fields {}, :name string} Updates an existing tag.
(locations-entryGroups-entries-testIamPermissions$ auth args body)
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
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:
A caller is not required to have Google IAM permission to make this request.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/entryGroups/entries/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} 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, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud Data Catalog. A caller is not required to have Google IAM permission to make this request.
(locations-entryGroups-get$ auth args)
Required parameters: name
Optional parameters: readMask Gets an EntryGroup.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/entryGroups/get Required parameters: name Optional parameters: readMask Gets an EntryGroup.
(locations-entryGroups-getIamPolicy$ auth args body)
Required parameters: resource
Optional parameters: none
Body:
{:options {:requestedPolicyVersion integer}}
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:
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.https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/entryGroups/getIamPolicy Required parameters: resource Optional parameters: none Body: {:options {:requestedPolicyVersion integer}} 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, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud 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.
(locations-entryGroups-list$ auth args)
Required parameters: parent
Optional parameters: pageToken, pageSize Lists entry groups.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/entryGroups/list Required parameters: parent Optional parameters: pageToken, pageSize Lists entry groups.
(locations-entryGroups-patch$ auth args body)
Required parameters: name
Optional parameters: updateMask
Body:
{:dataCatalogTimestamps {:createTime string, :expireTime string, :updateTime string}, :name string, :displayName string, :description string}
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] (/data-catalog/docs/concepts/resource-project) for more
information).
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/entryGroups/patch Required parameters: name Optional parameters: updateMask Body: {:dataCatalogTimestamps {:createTime string, :expireTime string, :updateTime string}, :name string, :displayName string, :description string} 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] (/data-catalog/docs/concepts/resource-project) for more information).
(locations-entryGroups-setIamPolicy$ auth args body)
Required parameters: resource
Optional parameters: none
Body:
{:policy {:etag string, :version integer, :bindings [Binding]}}
Sets the access control policy for a resource. Replaces any existing policy. Supported resources are:
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.https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/entryGroups/setIamPolicy Required parameters: resource Optional parameters: none Body: {:policy {:etag string, :version integer, :bindings [Binding]}} 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, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud 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.
(locations-entryGroups-tags-create$ auth args body)
Required parameters: parent
Optional parameters: none
Body:
{:column string, :template string, :templateDisplayName string, :fields {}, :name string}
Creates a tag on an Entry.
Note: The project identified by the parent
parameter for the
tag
and the
tag
template
used to create the tag must be from the same organization.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/entryGroups/tags/create Required parameters: parent Optional parameters: none Body: {:column string, :template string, :templateDisplayName string, :fields {}, :name string} Creates a tag on an Entry. Note: The project identified by the `parent` parameter for the [tag](/data-catalog/docs/reference/rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template](/data-catalog/docs/reference/rest/v1beta1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be from the same organization.
(locations-entryGroups-tags-delete$ auth args)
Required parameters: name
Optional parameters: none Deletes a tag.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/entryGroups/tags/delete Required parameters: name Optional parameters: none Deletes a tag.
(locations-entryGroups-tags-list$ auth args)
Required parameters: parent
Optional parameters: pageSize, pageToken Lists the tags on an Entry.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/entryGroups/tags/list Required parameters: parent Optional parameters: pageSize, pageToken Lists the tags on an Entry.
(locations-entryGroups-tags-patch$ auth args body)
Required parameters: name
Optional parameters: updateMask
Body:
{:column string, :template string, :templateDisplayName string, :fields {}, :name string}
Updates an existing tag.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/entryGroups/tags/patch Required parameters: name Optional parameters: updateMask Body: {:column string, :template string, :templateDisplayName string, :fields {}, :name string} Updates an existing tag.
(locations-entryGroups-testIamPermissions$ auth args body)
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
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:
A caller is not required to have Google IAM permission to make this request.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/entryGroups/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} 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, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud Data Catalog. A caller is not required to have Google IAM permission to make this request.
(locations-tagTemplates-create$ auth args body)
Required parameters: parent
Optional parameters: tagTemplateId
Body:
{:fields {}, :name string, :displayName string}
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 for more
information).
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/tagTemplates/create Required parameters: parent Optional parameters: tagTemplateId Body: {:fields {}, :name string, :displayName string} 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](/data-catalog/docs/concepts/resource-project) for more information).
(locations-tagTemplates-delete$ auth args)
Required parameters: name
Optional parameters: force
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]
(/data-catalog/docs/concepts/resource-project) for more information).
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/tagTemplates/delete Required parameters: name Optional parameters: force 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] (/data-catalog/docs/concepts/resource-project) for more information).
(locations-tagTemplates-fields-create$ auth args body)
Required parameters: parent
Optional parameters: tagTemplateFieldId
Body:
{:isRequired boolean, :name string, :displayName string, :type {:enumType GoogleCloudDatacatalogV1beta1FieldTypeEnumType, :primitiveType string}, :order integer}
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 for more
information).
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/tagTemplates/fields/create Required parameters: parent Optional parameters: tagTemplateFieldId Body: {:isRequired boolean, :name string, :displayName string, :type {:enumType GoogleCloudDatacatalogV1beta1FieldTypeEnumType, :primitiveType string}, :order integer} 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](/data-catalog/docs/concepts/resource-project) for more information).
(locations-tagTemplates-fields-delete$ auth args)
Required parameters: name
Optional parameters: force
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]
(/data-catalog/docs/concepts/resource-project) for more information).
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/tagTemplates/fields/delete Required parameters: name Optional parameters: force 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] (/data-catalog/docs/concepts/resource-project) for more information).
(locations-tagTemplates-fields-patch$ auth args body)
Required parameters: name
Optional parameters: updateMask
Body:
{:isRequired boolean, :name string, :displayName string, :type {:enumType GoogleCloudDatacatalogV1beta1FieldTypeEnumType, :primitiveType string}, :order integer}
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]
(/data-catalog/docs/concepts/resource-project) for more information).
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/tagTemplates/fields/patch Required parameters: name Optional parameters: updateMask Body: {:isRequired boolean, :name string, :displayName string, :type {:enumType GoogleCloudDatacatalogV1beta1FieldTypeEnumType, :primitiveType string}, :order integer} 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] (/data-catalog/docs/concepts/resource-project) for more information).
(locations-tagTemplates-fields-rename$ auth args body)
Required parameters: name
Optional parameters: none
Body:
{:newTagTemplateFieldId string}
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 for more
information).
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/tagTemplates/fields/rename Required parameters: name Optional parameters: none Body: {:newTagTemplateFieldId string} 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](/data-catalog/docs/concepts/resource-project) for more information).
(locations-tagTemplates-get$ auth args)
Required parameters: name
Optional parameters: none Gets a tag template.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/tagTemplates/get Required parameters: name Optional parameters: none Gets a tag template.
(locations-tagTemplates-getIamPolicy$ auth args body)
Required parameters: resource
Optional parameters: none
Body:
{:options {:requestedPolicyVersion integer}}
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:
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.https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/tagTemplates/getIamPolicy Required parameters: resource Optional parameters: none Body: {:options {:requestedPolicyVersion integer}} 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, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud 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.
(locations-tagTemplates-patch$ auth args body)
Required parameters: name
Optional parameters: updateMask
Body:
{:fields {}, :name string, :displayName string}
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]
(/data-catalog/docs/concepts/resource-project) for more information).
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/tagTemplates/patch Required parameters: name Optional parameters: updateMask Body: {:fields {}, :name string, :displayName string} 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] (/data-catalog/docs/concepts/resource-project) for more information).
(locations-tagTemplates-setIamPolicy$ auth args body)
Required parameters: resource
Optional parameters: none
Body:
{:policy {:etag string, :version integer, :bindings [Binding]}}
Sets the access control policy for a resource. Replaces any existing policy. Supported resources are:
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.https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/tagTemplates/setIamPolicy Required parameters: resource Optional parameters: none Body: {:policy {:etag string, :version integer, :bindings [Binding]}} 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, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud 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.
(locations-tagTemplates-testIamPermissions$ auth args body)
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
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:
A caller is not required to have Google IAM permission to make this request.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/tagTemplates/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} 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, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud Data Catalog. A caller is not required to have Google IAM permission to make this request.
(locations-taxonomies-create$ auth args body)
Required parameters: parent
Optional parameters: none
Body:
{:name string, :displayName string, :description string, :activatedPolicyTypes [string]}
Creates a taxonomy in the specified project.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/taxonomies/create Required parameters: parent Optional parameters: none Body: {:name string, :displayName string, :description string, :activatedPolicyTypes [string]} Creates a taxonomy in the specified project.
(locations-taxonomies-delete$ auth args)
Required parameters: name
Optional parameters: none Deletes a taxonomy. This operation will also delete all policy tags in this taxonomy along with their associated policies.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/taxonomies/delete Required parameters: name Optional parameters: none Deletes a taxonomy. This operation will also delete all policy tags in this taxonomy along with their associated policies.
(locations-taxonomies-export$ auth args)
Required parameters: parent
Optional parameters: taxonomies, serializedTaxonomies Exports all taxonomies and their policy tags in a project.
This method generates SerializedTaxonomy protos with nested policy tags that can be used as an input for future ImportTaxonomies calls.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/taxonomies/export Required parameters: parent Optional parameters: taxonomies, serializedTaxonomies Exports all taxonomies and their policy tags in a project. This method generates SerializedTaxonomy protos with nested policy tags that can be used as an input for future ImportTaxonomies calls.
(locations-taxonomies-get$ auth args)
Required parameters: name
Optional parameters: none Gets a taxonomy.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/taxonomies/get Required parameters: name Optional parameters: none Gets a taxonomy.
(locations-taxonomies-getIamPolicy$ auth args body)
Required parameters: resource
Optional parameters: none
Body:
{:options {:requestedPolicyVersion integer}}
Gets the IAM policy for a taxonomy or a policy tag.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/taxonomies/getIamPolicy Required parameters: resource Optional parameters: none Body: {:options {:requestedPolicyVersion integer}} Gets the IAM policy for a taxonomy or a policy tag.
(locations-taxonomies-import$ auth args body)
Required parameters: parent
Optional parameters: none
Body:
{:inlineSource {:taxonomies [GoogleCloudDatacatalogV1beta1SerializedTaxonomy]}}
Imports all taxonomies and their policy tags to a project as new taxonomies.
This method provides a bulk taxonomy / policy tag creation using nested proto structure.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/taxonomies/import Required parameters: parent Optional parameters: none Body: {:inlineSource {:taxonomies [GoogleCloudDatacatalogV1beta1SerializedTaxonomy]}} Imports all taxonomies and their policy tags to a project as new taxonomies. This method provides a bulk taxonomy / policy tag creation using nested proto structure.
(locations-taxonomies-list$ auth args)
Required parameters: parent
Optional parameters: pageToken, pageSize Lists all taxonomies in a project in a particular location that the caller has permission to view.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/taxonomies/list Required parameters: parent Optional parameters: pageToken, pageSize Lists all taxonomies in a project in a particular location that the caller has permission to view.
(locations-taxonomies-patch$ auth args body)
Required parameters: name
Optional parameters: updateMask
Body:
{:name string, :displayName string, :description string, :activatedPolicyTypes [string]}
Updates a taxonomy.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/taxonomies/patch Required parameters: name Optional parameters: updateMask Body: {:name string, :displayName string, :description string, :activatedPolicyTypes [string]} Updates a taxonomy.
(locations-taxonomies-policyTags-create$ auth args body)
Required parameters: parent
Optional parameters: none
Body:
{:name string, :childPolicyTags [string], :displayName string, :description string, :parentPolicyTag string}
Creates a policy tag in the specified taxonomy.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/taxonomies/policyTags/create Required parameters: parent Optional parameters: none Body: {:name string, :childPolicyTags [string], :displayName string, :description string, :parentPolicyTag string} Creates a policy tag in the specified taxonomy.
(locations-taxonomies-policyTags-delete$ auth args)
Required parameters: name
Optional parameters: none Deletes a policy tag. Also deletes all of its descendant policy tags.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/taxonomies/policyTags/delete Required parameters: name Optional parameters: none Deletes a policy tag. Also deletes all of its descendant policy tags.
(locations-taxonomies-policyTags-get$ auth args)
Required parameters: name
Optional parameters: none Gets a policy tag.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/taxonomies/policyTags/get Required parameters: name Optional parameters: none Gets a policy tag.
(locations-taxonomies-policyTags-getIamPolicy$ auth args body)
Required parameters: resource
Optional parameters: none
Body:
{:options {:requestedPolicyVersion integer}}
Gets the IAM policy for a taxonomy or a policy tag.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/taxonomies/policyTags/getIamPolicy Required parameters: resource Optional parameters: none Body: {:options {:requestedPolicyVersion integer}} Gets the IAM policy for a taxonomy or a policy tag.
(locations-taxonomies-policyTags-list$ auth args)
Required parameters: parent
Optional parameters: pageToken, pageSize Lists all policy tags in a taxonomy.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/taxonomies/policyTags/list Required parameters: parent Optional parameters: pageToken, pageSize Lists all policy tags in a taxonomy.
(locations-taxonomies-policyTags-patch$ auth args body)
Required parameters: name
Optional parameters: updateMask
Body:
{:name string, :childPolicyTags [string], :displayName string, :description string, :parentPolicyTag string}
Updates a policy tag.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/taxonomies/policyTags/patch Required parameters: name Optional parameters: updateMask Body: {:name string, :childPolicyTags [string], :displayName string, :description string, :parentPolicyTag string} Updates a policy tag.
(locations-taxonomies-policyTags-setIamPolicy$ auth args body)
Required parameters: resource
Optional parameters: none
Body:
{:policy {:etag string, :version integer, :bindings [Binding]}}
Sets the IAM policy for a taxonomy or a policy tag.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/taxonomies/policyTags/setIamPolicy Required parameters: resource Optional parameters: none Body: {:policy {:etag string, :version integer, :bindings [Binding]}} Sets the IAM policy for a taxonomy or a policy tag.
(locations-taxonomies-policyTags-testIamPermissions$ auth args body)
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
Returns the permissions that a caller has on the specified taxonomy or policy tag.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/taxonomies/policyTags/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} Returns the permissions that a caller has on the specified taxonomy or policy tag.
(locations-taxonomies-setIamPolicy$ auth args body)
Required parameters: resource
Optional parameters: none
Body:
{:policy {:etag string, :version integer, :bindings [Binding]}}
Sets the IAM policy for a taxonomy or a policy tag.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/taxonomies/setIamPolicy Required parameters: resource Optional parameters: none Body: {:policy {:etag string, :version integer, :bindings [Binding]}} Sets the IAM policy for a taxonomy or a policy tag.
(locations-taxonomies-testIamPermissions$ auth args body)
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
Returns the permissions that a caller has on the specified taxonomy or policy tag.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1beta1/projects/locations/taxonomies/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} Returns the permissions that a caller has on the specified taxonomy or policy tag.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close