com.google.cloud.datacatalog.v1

Interface DataCatalogGrpc.AsyncService

All Known Implementing Classes:

DataCatalogGrpc.DataCatalogImplBase

Enclosing class:

DataCatalogGrpc

public static interface DataCatalogGrpc.AsyncService

 Data Catalog API service allows you to discover, understand, and manage
 your data.
 

Method Summary

Modifier and Type	Method and Description
default void	createEntry(CreateEntryRequest request, io.grpc.stub.StreamObserver<Entry> responseObserver) Creates an entry.
default void	createEntryGroup(CreateEntryGroupRequest request, io.grpc.stub.StreamObserver<EntryGroup> responseObserver) Creates an entry group.
default void	createTag(CreateTagRequest request, io.grpc.stub.StreamObserver<Tag> responseObserver) Creates a tag and assigns it to: * An [Entry][google.cloud.datacatalog.v1.Entry] if the method name is `projects.locations.entryGroups.entries.tags.create`.
default void	createTagTemplate(CreateTagTemplateRequest request, io.grpc.stub.StreamObserver<TagTemplate> responseObserver) Creates a tag template.
default void	createTagTemplateField(CreateTagTemplateFieldRequest request, io.grpc.stub.StreamObserver<TagTemplateField> responseObserver) Creates a field in a tag template.
default void	deleteEntry(DeleteEntryRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Deletes an existing entry.
default void	deleteEntryGroup(DeleteEntryGroupRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Deletes an entry group.
default void	deleteTag(DeleteTagRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Deletes a tag.
default void	deleteTagTemplate(DeleteTagTemplateRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Deletes a tag template and all tags that use it.
default void	deleteTagTemplateField(DeleteTagTemplateFieldRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Deletes a field in a tag template and all uses of this field from the tags based on this template.
default void	getEntry(GetEntryRequest request, io.grpc.stub.StreamObserver<Entry> responseObserver) Gets an entry.
default void	getEntryGroup(GetEntryGroupRequest request, io.grpc.stub.StreamObserver<EntryGroup> responseObserver) Gets an entry group.
default void	getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request, io.grpc.stub.StreamObserver<com.google.iam.v1.Policy> responseObserver) Gets the access control policy for a resource.
default void	getTagTemplate(GetTagTemplateRequest request, io.grpc.stub.StreamObserver<TagTemplate> responseObserver) Gets a tag template.
default void	importEntries(ImportEntriesRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Imports entries from a source, such as data previously dumped into a Cloud Storage bucket, into Data Catalog.
default void	listEntries(ListEntriesRequest request, io.grpc.stub.StreamObserver<ListEntriesResponse> responseObserver) Lists entries.
default void	listEntryGroups(ListEntryGroupsRequest request, io.grpc.stub.StreamObserver<ListEntryGroupsResponse> responseObserver) Lists entry groups.
default void	listTags(ListTagsRequest request, io.grpc.stub.StreamObserver<ListTagsResponse> responseObserver) Lists tags assigned to an [Entry][google.cloud.datacatalog.v1.Entry].
default void	lookupEntry(LookupEntryRequest request, io.grpc.stub.StreamObserver<Entry> responseObserver) Gets an entry by its target resource name.
default void	modifyEntryContacts(ModifyEntryContactsRequest request, io.grpc.stub.StreamObserver<Contacts> responseObserver) Modifies contacts, part of the business context of an [Entry][google.cloud.datacatalog.v1.Entry].
default void	modifyEntryOverview(ModifyEntryOverviewRequest request, io.grpc.stub.StreamObserver<EntryOverview> responseObserver) Modifies entry overview, part of the business context of an [Entry][google.cloud.datacatalog.v1.Entry].
default void	reconcileTags(ReconcileTagsRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) `ReconcileTags` creates or updates a list of tags on the entry.
default void	renameTagTemplateField(RenameTagTemplateFieldRequest request, io.grpc.stub.StreamObserver<TagTemplateField> responseObserver) Renames a field in a tag template.
default void	renameTagTemplateFieldEnumValue(RenameTagTemplateFieldEnumValueRequest request, io.grpc.stub.StreamObserver<TagTemplateField> responseObserver) Renames an enum value in a tag template.
default void	searchCatalog(SearchCatalogRequest request, io.grpc.stub.StreamObserver<SearchCatalogResponse> responseObserver) Searches Data Catalog for multiple resources like entries and tags that match a query.
default void	setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request, io.grpc.stub.StreamObserver<com.google.iam.v1.Policy> responseObserver) Sets an access control policy for a resource.
default void	starEntry(StarEntryRequest request, io.grpc.stub.StreamObserver<StarEntryResponse> responseObserver) Marks an [Entry][google.cloud.datacatalog.v1.Entry] as starred by the current user.
default void	testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request, io.grpc.stub.StreamObserver<com.google.iam.v1.TestIamPermissionsResponse> responseObserver) Gets your permissions on a resource.
default void	unstarEntry(UnstarEntryRequest request, io.grpc.stub.StreamObserver<UnstarEntryResponse> responseObserver) Marks an [Entry][google.cloud.datacatalog.v1.Entry] as NOT starred by the current user.
default void	updateEntry(UpdateEntryRequest request, io.grpc.stub.StreamObserver<Entry> responseObserver) Updates an existing entry.
default void	updateEntryGroup(UpdateEntryGroupRequest request, io.grpc.stub.StreamObserver<EntryGroup> responseObserver) Updates an entry group.
default void	updateTag(UpdateTagRequest request, io.grpc.stub.StreamObserver<Tag> responseObserver) Updates an existing tag.
default void	updateTagTemplate(UpdateTagTemplateRequest request, io.grpc.stub.StreamObserver<TagTemplate> responseObserver) Updates a tag template.
default void	updateTagTemplateField(UpdateTagTemplateFieldRequest request, io.grpc.stub.StreamObserver<TagTemplateField> responseObserver) Updates a field in a tag template.

Method Detail

searchCatalog

default void searchCatalog(SearchCatalogRequest request,
                           io.grpc.stub.StreamObserver<SearchCatalogResponse> responseObserver)

 Searches Data Catalog for multiple resources like entries and tags that
 match a query.
 This is a [Custom Method]
 (https://cloud.google.com/apis/design/custom_methods) that doesn't return
 all information on a resource, only its ID and high level fields. To get
 more information, you can subsequently call specific get methods.
 Note: Data Catalog search queries don't guarantee full recall. Results
 that match your query might not be returned, even in subsequent
 result pages. Additionally, returned (and not returned) results can vary
 if you repeat search queries.
 For more information, see [Data Catalog search syntax]
 (https://cloud.google.com/data-catalog/docs/how-to/search-reference).
 

createEntryGroup

default void createEntryGroup(CreateEntryGroupRequest request,
                              io.grpc.stub.StreamObserver<EntryGroup> responseObserver)

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

getEntryGroup

default void getEntryGroup(GetEntryGroupRequest request,
                           io.grpc.stub.StreamObserver<EntryGroup> responseObserver)

 Gets an entry group.
 

updateEntryGroup

default void updateEntryGroup(UpdateEntryGroupRequest request,
                              io.grpc.stub.StreamObserver<EntryGroup> responseObserver)

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

deleteEntryGroup

default void deleteEntryGroup(DeleteEntryGroupRequest request,
                              io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)

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

listEntryGroups

default void listEntryGroups(ListEntryGroupsRequest request,
                             io.grpc.stub.StreamObserver<ListEntryGroupsResponse> responseObserver)

 Lists entry groups.
 

createEntry

default void createEntry(CreateEntryRequest request,
                         io.grpc.stub.StreamObserver<Entry> responseObserver)

 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.
 

updateEntry

default void updateEntry(UpdateEntryRequest request,
                         io.grpc.stub.StreamObserver<Entry> responseObserver)

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

deleteEntry

default void deleteEntry(DeleteEntryRequest request,
                         io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)

 Deletes an existing entry.
 You can delete only the entries created by the
 [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.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).
 

getEntry

default void getEntry(GetEntryRequest request,
                      io.grpc.stub.StreamObserver<Entry> responseObserver)

 Gets an entry.
 

lookupEntry

default void lookupEntry(LookupEntryRequest request,
                         io.grpc.stub.StreamObserver<Entry> responseObserver)

 Gets an entry by its target resource name.
 The resource name comes from the source Google Cloud Platform service.
 

listEntries

default void listEntries(ListEntriesRequest request,
                         io.grpc.stub.StreamObserver<ListEntriesResponse> responseObserver)

 Lists entries.
 Note: Currently, this method can list only custom entries.
 To get a list of both custom and automatically created entries, use
 [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].
 

modifyEntryOverview

default void modifyEntryOverview(ModifyEntryOverviewRequest request,
                                 io.grpc.stub.StreamObserver<EntryOverview> responseObserver)

 Modifies entry overview, part of the business context of an
 [Entry][google.cloud.datacatalog.v1.Entry].
 To call this method, you must have the `datacatalog.entries.updateOverview`
 IAM permission on the corresponding project.
 

modifyEntryContacts

default void modifyEntryContacts(ModifyEntryContactsRequest request,
                                 io.grpc.stub.StreamObserver<Contacts> responseObserver)

 Modifies contacts, part of the business context of an
 [Entry][google.cloud.datacatalog.v1.Entry].
 To call this method, you must have the `datacatalog.entries.updateContacts`
 IAM permission on the corresponding project.
 

createTagTemplate

default void createTagTemplate(CreateTagTemplateRequest request,
                               io.grpc.stub.StreamObserver<TagTemplate> responseObserver)

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

getTagTemplate

default void getTagTemplate(GetTagTemplateRequest request,
                            io.grpc.stub.StreamObserver<TagTemplate> responseObserver)

 Gets a tag template.
 

updateTagTemplate

default void updateTagTemplate(UpdateTagTemplateRequest request,
                               io.grpc.stub.StreamObserver<TagTemplate> responseObserver)

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

deleteTagTemplate

default void deleteTagTemplate(DeleteTagTemplateRequest request,
                               io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)

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

createTagTemplateField

default void createTagTemplateField(CreateTagTemplateFieldRequest request,
                                    io.grpc.stub.StreamObserver<TagTemplateField> responseObserver)

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

updateTagTemplateField

default void updateTagTemplateField(UpdateTagTemplateFieldRequest request,
                                    io.grpc.stub.StreamObserver<TagTemplateField> responseObserver)

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

renameTagTemplateField

default void renameTagTemplateField(RenameTagTemplateFieldRequest request,
                                    io.grpc.stub.StreamObserver<TagTemplateField> responseObserver)

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

renameTagTemplateFieldEnumValue

default void renameTagTemplateFieldEnumValue(RenameTagTemplateFieldEnumValueRequest request,
                                             io.grpc.stub.StreamObserver<TagTemplateField> responseObserver)

 Renames an enum value in a tag template.
 Within a single enum field, enum values must be unique.
 

deleteTagTemplateField

default void deleteTagTemplateField(DeleteTagTemplateFieldRequest request,
                                    io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)

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

createTag

default void createTag(CreateTagRequest request,
                       io.grpc.stub.StreamObserver<Tag> responseObserver)

 Creates a tag and assigns it to:
 * An [Entry][google.cloud.datacatalog.v1.Entry] if the method name is
   `projects.locations.entryGroups.entries.tags.create`.
 * Or [EntryGroup][google.cloud.datacatalog.v1.EntryGroup]if 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.
 

updateTag

default void updateTag(UpdateTagRequest request,
                       io.grpc.stub.StreamObserver<Tag> responseObserver)

 Updates an existing tag.
 

deleteTag

default void deleteTag(DeleteTagRequest request,
                       io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)

 Deletes a tag.
 

listTags

default void listTags(ListTagsRequest request,
                      io.grpc.stub.StreamObserver<ListTagsResponse> responseObserver)

 Lists tags assigned to an [Entry][google.cloud.datacatalog.v1.Entry].
 The [columns][google.cloud.datacatalog.v1.Tag.column] in the response are
 lowercased.
 

reconcileTags

default void reconcileTags(ReconcileTagsRequest request,
                           io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 `ReconcileTags` creates or updates a list of tags on the entry.
 If the
 [ReconcileTagsRequest.force_delete_missing][google.cloud.datacatalog.v1.ReconcileTagsRequest.force_delete_missing]
 parameter is set, the operation deletes tags not included in the input tag
 list.
 `ReconcileTags` returns a [long-running operation]
 [google.longrunning.Operation] resource that can be queried with
 [Operations.GetOperation][google.longrunning.Operations.GetOperation]
 to return [ReconcileTagsMetadata]
 [google.cloud.datacatalog.v1.ReconcileTagsMetadata] and
 a [ReconcileTagsResponse]
 [google.cloud.datacatalog.v1.ReconcileTagsResponse] message.
 

starEntry

default void starEntry(StarEntryRequest request,
                       io.grpc.stub.StreamObserver<StarEntryResponse> responseObserver)

 Marks an [Entry][google.cloud.datacatalog.v1.Entry] as starred by
 the current user. Starring information is private to each user.
 

unstarEntry

default void unstarEntry(UnstarEntryRequest request,
                         io.grpc.stub.StreamObserver<UnstarEntryResponse> responseObserver)

 Marks an [Entry][google.cloud.datacatalog.v1.Entry] as NOT starred by
 the current user. Starring information is private to each user.
 

setIamPolicy

default void setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request,
                          io.grpc.stub.StreamObserver<com.google.iam.v1.Policy> responseObserver)

 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.
 

getIamPolicy

default void getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request,
                          io.grpc.stub.StreamObserver<com.google.iam.v1.Policy> responseObserver)

 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.
 

testIamPermissions

default void testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request,
                                io.grpc.stub.StreamObserver<com.google.iam.v1.TestIamPermissionsResponse> responseObserver)

 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.
 

importEntries

default void importEntries(ImportEntriesRequest request,
                           io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Imports entries from a source, such as data previously dumped into a
 Cloud Storage bucket, into Data Catalog. Import of entries
 is a sync operation that reconciles the state of the third-party system
 with the Data Catalog.
 `ImportEntries` accepts source data snapshots of a third-party system.
 Snapshot should be delivered as a .wire or base65-encoded .txt file
 containing a sequence of Protocol Buffer messages of
 [DumpItem][google.cloud.datacatalog.v1.DumpItem] type.
 `ImportEntries` returns a [long-running operation]
 [google.longrunning.Operation] resource that can be queried with
 [Operations.GetOperation][google.longrunning.Operations.GetOperation]
 to return
 [ImportEntriesMetadata][google.cloud.datacatalog.v1.ImportEntriesMetadata]
 and an
 [ImportEntriesResponse][google.cloud.datacatalog.v1.ImportEntriesResponse]
 message.