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/v1/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/v1/projects
(locations-entryGroups-create$ auth parameters body)
Required parameters: parent
Optional parameters: entryGroupId
Body:
{:description string, :name string, :dataCatalogTimestamps {:expireTime string, :updateTime string, :createTime string}, :displayName string}
Creates an entry group. An entry group contains logically related entries together with Cloud Identity and Access Management 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/api/reference/rest/v1/projects/locations/entryGroups/create Required parameters: parent Optional parameters: entryGroupId Body: {:description string, :name string, :dataCatalogTimestamps {:expireTime string, :updateTime string, :createTime string}, :displayName string} 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).
(locations-entryGroups-delete$ auth parameters)
Required parameters: name
Optional parameters: force
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/api/reference/rest/v1/projects/locations/entryGroups/delete Required parameters: name Optional parameters: force 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).
(locations-entryGroups-entries-create$ auth parameters body)
Required parameters: parent
Optional parameters: entryId
Body:
{:description string, :schema {:columns [GoogleCloudDatacatalogV1ColumnSchema]}, :labels {}, :bigqueryDateShardedSpec {:dataset string, :shardCount string, :tablePrefix string}, :userSpecifiedSystem string, :sourceSystemTimestamps {:expireTime string, :updateTime string, :createTime string}, :displayName string, :name string, :usageSignal {:usageWithinTimeRange {}, :updateTime string}, :gcsFilesetSpec {:filePatterns [string], :sampleGcsFileSpecs [GoogleCloudDatacatalogV1GcsFileSpec]}, :type string, :bigqueryTableSpec {:tableSourceType string, :viewSpec GoogleCloudDatacatalogV1ViewSpec, :tableSpec GoogleCloudDatacatalogV1TableSpec}, :linkedResource string, :routineSpec {:routineArguments [GoogleCloudDatacatalogV1RoutineSpecArgument], :returnType string, :bigqueryRoutineSpec GoogleCloudDatacatalogV1BigQueryRoutineSpec, :language string, :routineType string, :definitionBody string}, :dataSourceConnectionSpec {:bigqueryConnectionSpec GoogleCloudDatacatalogV1BigQueryConnectionSpec}, :dataSource {:resource string, :service string}, :databaseTableSpec {:type string}, :userSpecifiedType string, :integratedSystem string, :fullyQualifiedName string}
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. An entry group can have a maximum of 100,000 entries.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/entryGroups/entries/create Required parameters: parent Optional parameters: entryId Body: {:description string, :schema {:columns [GoogleCloudDatacatalogV1ColumnSchema]}, :labels {}, :bigqueryDateShardedSpec {:dataset string, :shardCount string, :tablePrefix string}, :userSpecifiedSystem string, :sourceSystemTimestamps {:expireTime string, :updateTime string, :createTime string}, :displayName string, :name string, :usageSignal {:usageWithinTimeRange {}, :updateTime string}, :gcsFilesetSpec {:filePatterns [string], :sampleGcsFileSpecs [GoogleCloudDatacatalogV1GcsFileSpec]}, :type string, :bigqueryTableSpec {:tableSourceType string, :viewSpec GoogleCloudDatacatalogV1ViewSpec, :tableSpec GoogleCloudDatacatalogV1TableSpec}, :linkedResource string, :routineSpec {:routineArguments [GoogleCloudDatacatalogV1RoutineSpecArgument], :returnType string, :bigqueryRoutineSpec GoogleCloudDatacatalogV1BigQueryRoutineSpec, :language string, :routineType string, :definitionBody string}, :dataSourceConnectionSpec {:bigqueryConnectionSpec GoogleCloudDatacatalogV1BigQueryConnectionSpec}, :dataSource {:resource string, :service string}, :databaseTableSpec {:type string}, :userSpecifiedType string, :integratedSystem string, :fullyQualifiedName string} 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.
(locations-entryGroups-entries-delete$ auth parameters)
Required parameters: name
Optional parameters: none
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/api/reference/rest/v1/projects/locations/entryGroups/entries/delete Required parameters: name Optional parameters: none 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).
(locations-entryGroups-entries-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets an entry.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/entryGroups/entries/get Required parameters: name Optional parameters: none Gets an entry.
(locations-entryGroups-entries-getIamPolicy$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:options {:requestedPolicyVersion integer}}
Gets the access control policy for a resource. May return: * ANOT_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.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/entryGroups/entries/getIamPolicy Required parameters: resource Optional parameters: none Body: {:options {:requestedPolicyVersion integer}} 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.
(locations-entryGroups-entries-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, readMask, pageToken
Lists entries.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/entryGroups/entries/list Required parameters: parent Optional parameters: pageSize, readMask, pageToken Lists entries.
(locations-entryGroups-entries-patch$ auth parameters body)
Required parameters: name
Optional parameters: updateMask
Body:
{:description string, :schema {:columns [GoogleCloudDatacatalogV1ColumnSchema]}, :labels {}, :bigqueryDateShardedSpec {:dataset string, :shardCount string, :tablePrefix string}, :userSpecifiedSystem string, :sourceSystemTimestamps {:expireTime string, :updateTime string, :createTime string}, :displayName string, :name string, :usageSignal {:usageWithinTimeRange {}, :updateTime string}, :gcsFilesetSpec {:filePatterns [string], :sampleGcsFileSpecs [GoogleCloudDatacatalogV1GcsFileSpec]}, :type string, :bigqueryTableSpec {:tableSourceType string, :viewSpec GoogleCloudDatacatalogV1ViewSpec, :tableSpec GoogleCloudDatacatalogV1TableSpec}, :linkedResource string, :routineSpec {:routineArguments [GoogleCloudDatacatalogV1RoutineSpecArgument], :returnType string, :bigqueryRoutineSpec GoogleCloudDatacatalogV1BigQueryRoutineSpec, :language string, :routineType string, :definitionBody string}, :dataSourceConnectionSpec {:bigqueryConnectionSpec GoogleCloudDatacatalogV1BigQueryConnectionSpec}, :dataSource {:resource string, :service string}, :databaseTableSpec {:type string}, :userSpecifiedType string, :integratedSystem string, :fullyQualifiedName string}
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/api/reference/rest/v1/projects/locations/entryGroups/entries/patch Required parameters: name Optional parameters: updateMask Body: {:description string, :schema {:columns [GoogleCloudDatacatalogV1ColumnSchema]}, :labels {}, :bigqueryDateShardedSpec {:dataset string, :shardCount string, :tablePrefix string}, :userSpecifiedSystem string, :sourceSystemTimestamps {:expireTime string, :updateTime string, :createTime string}, :displayName string, :name string, :usageSignal {:usageWithinTimeRange {}, :updateTime string}, :gcsFilesetSpec {:filePatterns [string], :sampleGcsFileSpecs [GoogleCloudDatacatalogV1GcsFileSpec]}, :type string, :bigqueryTableSpec {:tableSourceType string, :viewSpec GoogleCloudDatacatalogV1ViewSpec, :tableSpec GoogleCloudDatacatalogV1TableSpec}, :linkedResource string, :routineSpec {:routineArguments [GoogleCloudDatacatalogV1RoutineSpecArgument], :returnType string, :bigqueryRoutineSpec GoogleCloudDatacatalogV1BigQueryRoutineSpec, :language string, :routineType string, :definitionBody string}, :dataSourceConnectionSpec {:bigqueryConnectionSpec GoogleCloudDatacatalogV1BigQueryConnectionSpec}, :dataSource {:resource string, :service string}, :databaseTableSpec {:type string}, :userSpecifiedType string, :integratedSystem string, :fullyQualifiedName string} 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).
(locations-entryGroups-entries-tags-create$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:template string, :fields {}, :column string, :name string, :templateDisplayName string}
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.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/entryGroups/entries/tags/create Required parameters: parent Optional parameters: none Body: {:template string, :fields {}, :column string, :name string, :templateDisplayName string} 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.
(locations-entryGroups-entries-tags-delete$ auth parameters)
Required parameters: name
Optional parameters: none
Deletes a tag.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/entryGroups/entries/tags/delete Required parameters: name Optional parameters: none Deletes a tag.
(locations-entryGroups-entries-tags-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken
Lists tags assigned to an Entry.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/entryGroups/entries/tags/list Required parameters: parent Optional parameters: pageSize, pageToken Lists tags assigned to an Entry.
(locations-entryGroups-entries-tags-patch$ auth parameters body)
Required parameters: name
Optional parameters: updateMask
Body:
{:template string, :fields {}, :column string, :name string, :templateDisplayName string}
Updates an existing tag.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/entryGroups/entries/tags/patch Required parameters: name Optional parameters: updateMask Body: {:template string, :fields {}, :column string, :name string, :templateDisplayName string} Updates an existing tag.
(locations-entryGroups-entries-testIamPermissions$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
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.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/entryGroups/entries/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} 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.
(locations-entryGroups-get$ auth parameters)
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/entryGroups/get
Required parameters: name
Optional parameters: readMask
Gets an entry group.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/entryGroups/get Required parameters: name Optional parameters: readMask Gets an entry group.
(locations-entryGroups-getIamPolicy$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:options {:requestedPolicyVersion integer}}
Gets the access control policy for a resource. May return: * ANOT_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.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/entryGroups/getIamPolicy Required parameters: resource Optional parameters: none Body: {:options {:requestedPolicyVersion integer}} 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.
(locations-entryGroups-list$ auth parameters)
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/entryGroups/list
Required parameters: parent
Optional parameters: pageToken, pageSize
Lists entry groups.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/entryGroups/list Required parameters: parent Optional parameters: pageToken, pageSize Lists entry groups.
(locations-entryGroups-patch$ auth parameters body)
Required parameters: name
Optional parameters: updateMask
Body:
{:description string, :name string, :dataCatalogTimestamps {:expireTime string, :updateTime string, :createTime string}, :displayName string}
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/api/reference/rest/v1/projects/locations/entryGroups/patch Required parameters: name Optional parameters: updateMask Body: {:description string, :name string, :dataCatalogTimestamps {:expireTime string, :updateTime string, :createTime string}, :displayName string} 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).
(locations-entryGroups-setIamPolicy$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:policy {:version integer, :etag string, :bindings [Binding]}}
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.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/entryGroups/setIamPolicy Required parameters: resource Optional parameters: none Body: {:policy {:version integer, :etag string, :bindings [Binding]}} 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.
(locations-entryGroups-tags-create$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:template string, :fields {}, :column string, :name string, :templateDisplayName string}
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.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/entryGroups/tags/create Required parameters: parent Optional parameters: none Body: {:template string, :fields {}, :column string, :name string, :templateDisplayName string} 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.
(locations-entryGroups-tags-delete$ auth parameters)
Required parameters: name
Optional parameters: none
Deletes a tag.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/entryGroups/tags/delete Required parameters: name Optional parameters: none Deletes a tag.
(locations-entryGroups-tags-list$ auth parameters)
Required parameters: parent
Optional parameters: pageToken, pageSize
Lists tags assigned to an Entry.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/entryGroups/tags/list Required parameters: parent Optional parameters: pageToken, pageSize Lists tags assigned to an Entry.
(locations-entryGroups-tags-patch$ auth parameters body)
Required parameters: name
Optional parameters: updateMask
Body:
{:template string, :fields {}, :column string, :name string, :templateDisplayName string}
Updates an existing tag.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/entryGroups/tags/patch Required parameters: name Optional parameters: updateMask Body: {:template string, :fields {}, :column string, :name string, :templateDisplayName string} Updates an existing tag.
(locations-entryGroups-testIamPermissions$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
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.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/entryGroups/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} 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.
(locations-tagTemplates-create$ auth parameters body)
Required parameters: parent
Optional parameters: tagTemplateId
Body:
{:isPubliclyReadable boolean, :fields {}, :name string, :displayName string}
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).
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/tagTemplates/create Required parameters: parent Optional parameters: tagTemplateId Body: {:isPubliclyReadable boolean, :fields {}, :name string, :displayName string} 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).
(locations-tagTemplates-delete$ auth parameters)
Required parameters: name
Optional parameters: force
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/api/reference/rest/v1/projects/locations/tagTemplates/delete Required parameters: name Optional parameters: force 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).
(locations-tagTemplates-fields-create$ auth parameters body)
Required parameters: parent
Optional parameters: tagTemplateFieldId
Body:
{:type {:enumType GoogleCloudDatacatalogV1FieldTypeEnumType, :primitiveType string}, :name string, :displayName string, :order integer, :description string, :isRequired boolean}
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/api/reference/rest/v1/projects/locations/tagTemplates/fields/create Required parameters: parent Optional parameters: tagTemplateFieldId Body: {:type {:enumType GoogleCloudDatacatalogV1FieldTypeEnumType, :primitiveType string}, :name string, :displayName string, :order integer, :description string, :isRequired boolean} 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).
(locations-tagTemplates-fields-delete$ auth parameters)
Required parameters: name
Optional parameters: force
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/api/reference/rest/v1/projects/locations/tagTemplates/fields/delete Required parameters: name Optional parameters: force 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).
(locations-tagTemplates-fields-enumValues-rename$ auth parameters body)
Required parameters: name
Optional parameters: none
Body:
{:newEnumValueDisplayName string}
Renames an enum value in a tag template. Within a single enum field, enum values must be unique.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/tagTemplates/fields/enumValues/rename Required parameters: name Optional parameters: none Body: {:newEnumValueDisplayName string} Renames an enum value in a tag template. Within a single enum field, enum values must be unique.
(locations-tagTemplates-fields-patch$ auth parameters body)
Required parameters: name
Optional parameters: updateMask
Body:
{:type {:enumType GoogleCloudDatacatalogV1FieldTypeEnumType, :primitiveType string}, :name string, :displayName string, :order integer, :description string, :isRequired boolean}
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/api/reference/rest/v1/projects/locations/tagTemplates/fields/patch Required parameters: name Optional parameters: updateMask Body: {:type {:enumType GoogleCloudDatacatalogV1FieldTypeEnumType, :primitiveType string}, :name string, :displayName string, :order integer, :description string, :isRequired boolean} 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).
(locations-tagTemplates-fields-rename$ auth parameters body)
Required parameters: name
Optional parameters: none
Body:
{:newTagTemplateFieldId string}
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).
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/tagTemplates/fields/rename Required parameters: name Optional parameters: none Body: {:newTagTemplateFieldId string} 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).
(locations-tagTemplates-get$ auth parameters)
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/tagTemplates/get
Required parameters: name
Optional parameters: none
Gets a tag template.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/tagTemplates/get Required parameters: name Optional parameters: none Gets a tag template.
(locations-tagTemplates-getIamPolicy$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:options {:requestedPolicyVersion integer}}
Gets the access control policy for a resource. May return: * ANOT_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.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/tagTemplates/getIamPolicy Required parameters: resource Optional parameters: none Body: {:options {:requestedPolicyVersion integer}} 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.
(locations-tagTemplates-patch$ auth parameters body)
Required parameters: name
Optional parameters: updateMask
Body:
{:isPubliclyReadable boolean, :fields {}, :name string, :displayName string}
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/api/reference/rest/v1/projects/locations/tagTemplates/patch Required parameters: name Optional parameters: updateMask Body: {:isPubliclyReadable boolean, :fields {}, :name string, :displayName string} 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).
(locations-tagTemplates-setIamPolicy$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:policy {:version integer, :etag string, :bindings [Binding]}}
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.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/tagTemplates/setIamPolicy Required parameters: resource Optional parameters: none Body: {:policy {:version integer, :etag string, :bindings [Binding]}} 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.
(locations-tagTemplates-testIamPermissions$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
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.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/tagTemplates/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} 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.
(locations-taxonomies-create$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:displayName string, :description string, :name string, :policyTagCount integer, :activatedPolicyTypes [string], :taxonomyTimestamps {:expireTime string, :updateTime string, :createTime string}}
Creates a taxonomy in a specified project. The taxonomy is initially empty, that is, it doesn't contain policy tags.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/taxonomies/create Required parameters: parent Optional parameters: none Body: {:displayName string, :description string, :name string, :policyTagCount integer, :activatedPolicyTypes [string], :taxonomyTimestamps {:expireTime string, :updateTime string, :createTime string}} Creates a taxonomy in a specified project. The taxonomy is initially empty, that is, it doesn't contain policy tags.
(locations-taxonomies-delete$ auth parameters)
Required parameters: name
Optional parameters: none
Deletes a taxonomy, including all policy tags in this taxonomy, their associated policies, and the policy tags references from BigQuery columns.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/taxonomies/delete Required parameters: name Optional parameters: none Deletes a taxonomy, including all policy tags in this taxonomy, their associated policies, and the policy tags references from BigQuery columns.
(locations-taxonomies-export$ auth parameters)
Required parameters: parent
Optional parameters: taxonomies, serializedTaxonomies
Exports taxonomies in the requested type and returns them, including their policy tags. The requested taxonomies must belong to the same project. This method generates SerializedTaxonomy
protocol buffers with nested policy tags that can be used as input for ImportTaxonomies
calls.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/taxonomies/export Required parameters: parent Optional parameters: taxonomies, serializedTaxonomies Exports taxonomies in the requested type and returns them, including their policy tags. The requested taxonomies must belong to the same project. This method generates `SerializedTaxonomy` protocol buffers with nested policy tags that can be used as input for `ImportTaxonomies` calls.
(locations-taxonomies-get$ auth parameters)
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/taxonomies/get
Required parameters: name
Optional parameters: none
Gets a taxonomy.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/taxonomies/get Required parameters: name Optional parameters: none Gets a taxonomy.
(locations-taxonomies-getIamPolicy$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:options {:requestedPolicyVersion integer}}
Gets the IAM policy for a policy tag or a taxonomy.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/taxonomies/getIamPolicy Required parameters: resource Optional parameters: none Body: {:options {:requestedPolicyVersion integer}} Gets the IAM policy for a policy tag or a taxonomy.
(locations-taxonomies-import$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:crossRegionalSource {:taxonomy string}, :inlineSource {:taxonomies [GoogleCloudDatacatalogV1SerializedTaxonomy]}}
Creates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional sources. For a cross-regional source, new taxonomies are created by copying from a source in another region. For an inlined source, taxonomies and policy tags are created in bulk using nested protocol buffer structures.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/taxonomies/import Required parameters: parent Optional parameters: none Body: {:crossRegionalSource {:taxonomy string}, :inlineSource {:taxonomies [GoogleCloudDatacatalogV1SerializedTaxonomy]}} Creates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional sources. For a cross-regional source, new taxonomies are created by copying from a source in another region. For an inlined source, taxonomies and policy tags are created in bulk using nested protocol buffer structures.
(locations-taxonomies-list$ auth parameters)
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/taxonomies/list
Required parameters: parent
Optional parameters: pageToken, pageSize
Lists all taxonomies in a project in a particular location that you have a permission to view.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/taxonomies/list Required parameters: parent Optional parameters: pageToken, pageSize Lists all taxonomies in a project in a particular location that you have a permission to view.
(locations-taxonomies-patch$ auth parameters body)
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/taxonomies/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:displayName string, :description string, :name string, :policyTagCount integer, :activatedPolicyTypes [string], :taxonomyTimestamps {:expireTime string, :updateTime string, :createTime string}}
Updates a taxonomy, including its display name, description, and activated policy types.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/taxonomies/patch Required parameters: name Optional parameters: updateMask Body: {:displayName string, :description string, :name string, :policyTagCount integer, :activatedPolicyTypes [string], :taxonomyTimestamps {:expireTime string, :updateTime string, :createTime string}} Updates a taxonomy, including its display name, description, and activated policy types.
(locations-taxonomies-policyTags-create$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:displayName string, :parentPolicyTag string, :name string, :childPolicyTags [string], :description string}
Creates a policy tag in a taxonomy.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/taxonomies/policyTags/create Required parameters: parent Optional parameters: none Body: {:displayName string, :parentPolicyTag string, :name string, :childPolicyTags [string], :description string} Creates a policy tag in a taxonomy.
(locations-taxonomies-policyTags-delete$ auth parameters)
Required parameters: name
Optional parameters: none
Deletes a policy tag together with the following: * All of its descendant policy tags, if any * Policies associated with the policy tag and its descendants * References from BigQuery table schema of the policy tag and its descendants
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/taxonomies/policyTags/delete Required parameters: name Optional parameters: none Deletes a policy tag together with the following: * All of its descendant policy tags, if any * Policies associated with the policy tag and its descendants * References from BigQuery table schema of the policy tag and its descendants
(locations-taxonomies-policyTags-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets a policy tag.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/taxonomies/policyTags/get Required parameters: name Optional parameters: none Gets a policy tag.
(locations-taxonomies-policyTags-getIamPolicy$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:options {:requestedPolicyVersion integer}}
Gets the IAM policy for a policy tag or a taxonomy.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/taxonomies/policyTags/getIamPolicy Required parameters: resource Optional parameters: none Body: {:options {:requestedPolicyVersion integer}} Gets the IAM policy for a policy tag or a taxonomy.
(locations-taxonomies-policyTags-list$ auth parameters)
Required parameters: parent
Optional parameters: pageToken, pageSize
Lists all policy tags in a taxonomy.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/taxonomies/policyTags/list Required parameters: parent Optional parameters: pageToken, pageSize Lists all policy tags in a taxonomy.
(locations-taxonomies-policyTags-patch$ auth parameters body)
Required parameters: name
Optional parameters: updateMask
Body:
{:displayName string, :parentPolicyTag string, :name string, :childPolicyTags [string], :description string}
Updates a policy tag, including its display name, description, and parent policy tag.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/taxonomies/policyTags/patch Required parameters: name Optional parameters: updateMask Body: {:displayName string, :parentPolicyTag string, :name string, :childPolicyTags [string], :description string} Updates a policy tag, including its display name, description, and parent policy tag.
(locations-taxonomies-policyTags-setIamPolicy$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:policy {:version integer, :etag string, :bindings [Binding]}}
Sets the IAM policy for a policy tag or a taxonomy.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/taxonomies/policyTags/setIamPolicy Required parameters: resource Optional parameters: none Body: {:policy {:version integer, :etag string, :bindings [Binding]}} Sets the IAM policy for a policy tag or a taxonomy.
(locations-taxonomies-policyTags-testIamPermissions$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
Returns your permissions on a specified policy tag or taxonomy.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/taxonomies/policyTags/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} Returns your permissions on a specified policy tag or taxonomy.
(locations-taxonomies-replace$ auth parameters body)
Required parameters: name
Optional parameters: none
Body:
{:serializedTaxonomy {:displayName string, :activatedPolicyTypes [string], :description string, :policyTags [GoogleCloudDatacatalogV1SerializedPolicyTag]}}
Replaces (updates) a taxonomy and all its policy tags. The taxonomy and its entire hierarchy of policy tags must be represented literally by SerializedTaxonomy
and the nested SerializedPolicyTag
messages. This operation automatically does the following: - Deletes the existing policy tags that are missing from the SerializedPolicyTag
. - Creates policy tags that don't have resource names. They are considered new. - Updates policy tags with valid resources names accordingly.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/taxonomies/replace Required parameters: name Optional parameters: none Body: {:serializedTaxonomy {:displayName string, :activatedPolicyTypes [string], :description string, :policyTags [GoogleCloudDatacatalogV1SerializedPolicyTag]}} Replaces (updates) a taxonomy and all its policy tags. The taxonomy and its entire hierarchy of policy tags must be represented literally by `SerializedTaxonomy` and the nested `SerializedPolicyTag` messages. This operation automatically does the following: - Deletes the existing policy tags that are missing from the `SerializedPolicyTag`. - Creates policy tags that don't have resource names. They are considered new. - Updates policy tags with valid resources names accordingly.
(locations-taxonomies-setIamPolicy$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:policy {:version integer, :etag string, :bindings [Binding]}}
Sets the IAM policy for a policy tag or a taxonomy.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/taxonomies/setIamPolicy Required parameters: resource Optional parameters: none Body: {:policy {:version integer, :etag string, :bindings [Binding]}} Sets the IAM policy for a policy tag or a taxonomy.
(locations-taxonomies-testIamPermissions$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
Returns your permissions on a specified policy tag or taxonomy.
https://cloud.google.com/data-catalog/docs/api/reference/rest/v1/projects/locations/taxonomies/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} Returns your permissions on a specified policy tag or taxonomy.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close