com.google.cloud.datacatalog.v1beta1

Interface DataCatalogGrpc.AsyncService

All Known Implementing Classes:

DataCatalogGrpc.DataCatalogImplBase

Enclosing class:

DataCatalogGrpc

public static interface DataCatalogGrpc.AsyncService

 Data Catalog API service allows clients to discover, understand, and manage
 their 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) A maximum of 10,000 entry groups may be created per organization across all locations.
default void	createTag(CreateTagRequest request, io.grpc.stub.StreamObserver<Tag> responseObserver) Creates a tag on an [Entry][google.cloud.datacatalog.v1beta1.Entry].
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 EntryGroup.
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 using the template.
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 that field.
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 EntryGroup.
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	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.v1beta1.Entry].
default void	lookupEntry(LookupEntryRequest request, io.grpc.stub.StreamObserver<Entry> responseObserver) Get an entry by target resource name.
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, 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 the access control policy for a resource.
default void	testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request, io.grpc.stub.StreamObserver<com.google.iam.v1.TestIamPermissionsResponse> responseObserver) Returns the caller's permissions on a resource.
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 EntryGroup.
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, tags that
 match a query.
 This is a custom method
 (https://cloud.google.com/apis/design/custom_methods) and does not return
 the complete resource, only the resource identifier and high level
 fields. Clients can subsequently call `Get` methods.
 Note that Data Catalog search queries do not guarantee full recall. Query
 results that match your query may not be returned, even in subsequent
 result pages. Also note that results returned (and not returned) can vary
 across repeated search queries.
 See [Data Catalog Search
 Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference)
 for more information.
 

createEntryGroup

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

 A maximum of 10,000 entry groups may be created per organization across all
 locations.
 Users should enable the Data Catalog API in the project identified by
 the `parent` parameter (see [Data Catalog Resource Project]
 (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
 more information).
 

updateEntryGroup

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

 Updates an EntryGroup. The user should enable the Data Catalog API in the
 project identified by the `entry_group.name` parameter (see [Data Catalog
 Resource Project]
 (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
 more information).
 

getEntryGroup

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

 Gets an EntryGroup.
 

deleteEntryGroup

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

 Deletes an EntryGroup. Only entry groups that do not contain entries can be
 deleted. Users should enable the Data Catalog API in the project
 identified by the `name` parameter (see [Data Catalog Resource Project]
 (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
 more information).
 

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. Only entries of 'FILESET' type or user-specified type can
 be created.
 Users should enable the Data Catalog API in the project identified by
 the `parent` parameter (see [Data Catalog Resource Project]
 (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
 more information).
 A maximum of 100,000 entries may be created per entry group.
 

updateEntry

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

 Updates an existing entry.
 Users should enable the Data Catalog API in the project identified by
 the `entry.name` parameter (see [Data Catalog Resource Project]
 (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
 more information).
 

deleteEntry

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

 Deletes an existing entry. Only entries created through
 [CreateEntry][google.cloud.datacatalog.v1beta1.DataCatalog.CreateEntry]
 method can be deleted.
 Users should enable the Data Catalog API in the project identified by
 the `name` parameter (see [Data Catalog Resource Project]
 (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
 more information).
 

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)

 Get an entry by target resource name. This method allows clients to use
 the resource name from the source Google Cloud Platform service to get the
 Data Catalog Entry.
 

listEntries

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

 Lists entries.
 

createTagTemplate

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

 Creates a tag template. The user should enable the Data Catalog API in
 the project identified by the `parent` parameter (see [Data Catalog
 Resource
 Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project)
 for more information).
 

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. This method cannot be used to update the fields of
 a template. The tag template fields are represented as separate resources
 and should be updated using their own create/update/delete methods.
 Users should enable the Data Catalog API in the project identified by
 the `tag_template.name` parameter (see [Data Catalog Resource Project]
 (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
 more information).
 

deleteTagTemplate

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

 Deletes a tag template and all tags using the template.
 Users should enable the Data Catalog API in the project identified by
 the `name` parameter (see [Data Catalog Resource Project]
 (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
 more information).
 

createTagTemplateField

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

 Creates a field in a tag template. The user should enable the Data Catalog
 API in the project identified by the `parent` parameter (see
 [Data Catalog Resource
 Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project)
 for more information).
 

updateTagTemplateField

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

 Updates a field in a tag template. This method cannot be used to update the
 field type. Users should enable the Data Catalog API in the project
 identified by the `name` parameter (see [Data Catalog Resource Project]
 (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
 more information).
 

renameTagTemplateField

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

 Renames a field in a tag template. The user should enable the Data Catalog
 API in the project identified by the `name` parameter (see [Data Catalog
 Resource
 Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project)
 for more information).
 

renameTagTemplateFieldEnumValue

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

 Renames an enum value in a tag template. The enum values have to be unique
 within one enum field. Thus, an enum value cannot be renamed with a name
 used in any other enum value within the same enum field.
 

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 that field.
 Users should enable the Data Catalog API in the project identified by
 the `name` parameter (see [Data Catalog Resource Project]
 (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
 more information).
 

createTag

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

 Creates a tag on an [Entry][google.cloud.datacatalog.v1beta1.Entry].
 Note: The project identified by the `parent` parameter for the
 [tag](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path-parameters)
 and the
 [tag
 template](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.tagTemplates/create#path-parameters)
 used to create the tag must be from the same organization.
 

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.v1beta1.Entry].
 The [columns][google.cloud.datacatalog.v1beta1.Tag.column] in the response
 are lowercased.
 

setIamPolicy

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

 Sets the access control policy for a resource. Replaces any existing
 policy.
 Supported resources are:
   - Tag templates.
   - Entries.
   - Entry groups.
 Note, this method cannot be used to manage policies for BigQuery, Pub/Sub
 and any external Google Cloud Platform resources synced to Data Catalog.
 Callers must have following Google IAM permission
   - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag
     templates.
   - `datacatalog.entries.setIamPolicy` to set policies on entries.
   - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
 

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. A `NOT_FOUND` error
 is returned if the resource does not exist. An empty policy is returned
 if the resource exists but does not have a policy set on it.
 Supported resources are:
   - Tag templates.
   - Entries.
   - Entry groups.
 Note, this method cannot be used to manage policies for BigQuery, Pub/Sub
 and any external Google Cloud Platform resources synced to Data Catalog.
 Callers must have following Google IAM permission
   - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag
     templates.
   - `datacatalog.entries.getIamPolicy` to get policies on entries.
   - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
 

testIamPermissions

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

 Returns the caller's permissions on a resource.
 If the resource does not exist, an empty set of permissions is returned
 (We don't return a `NOT_FOUND` error).
 Supported resources are:
   - Tag templates.
   - Entries.
   - Entry groups.
 Note, this method cannot be used to manage policies for BigQuery, Pub/Sub
 and any external Google Cloud Platform resources synced to Data Catalog.
 A caller is not required to have Google IAM permission to make this
 request.